This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks",
+ "html": "This API is under preview and subject to change.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'",
+ "html": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "config"
+ ]
+ },
+ "example": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42",
+ "html": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'",
+ "html": "Key/value pairs to provide settings for this webhook.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Key/value pairs to provide settings for this webhook.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42",
+ "html": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings",
+ "html": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys",
+ "html": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response",
+ "payload": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response",
+ "payload": "The organization's display name.
",
+ "name": "profile_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's display name.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "login",
+ "admin"
+ ]
+ },
+ "example": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ },
+ "slug": "create-an-organization",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "orgs",
+ "subcategoryLabel": "Orgs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The organization's display name.
",
+ "name": "profile_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's display name.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nAPIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nAPIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nThis pre-receive environment's new name.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "This pre-receive environment's new name.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "URL from which to download a tarball of this environment.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nYou cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "This pre-receive environment's new name.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "This pre-receive environment's new name.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "URL from which to download a tarball of this environment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nIf you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.
\nAPIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nAPIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nThe state of enforcement for this hook. default: disabled
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook. default: `disabled`",
+ "childParamsGroups": []
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level. default: false
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "script",
+ "script_repository",
+ "environment"
+ ]
+ },
+ "example": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nThe state of enforcement for this hook. default: disabled
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook. default: `disabled`",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level. default: false
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nThe name of the hook.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the hook.",
+ "childParamsGroups": []
+ },
+ "script": {
+ "type": "string",
+ "description": "The script that the hook runs.
",
+ "name": "script",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The script that the hook runs.",
+ "childParamsGroups": []
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "script_repository",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The GitHub repository where the script is kept.",
+ "childParamsGroups": []
+ },
+ "environment": {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "environment",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The pre-receive environment where the script is executed.",
+ "childParamsGroups": []
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook.
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook.",
+ "childParamsGroups": []
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level.
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nThe name of the hook.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the hook.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The script that the hook runs.
",
+ "name": "script",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The script that the hook runs.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "script_repository",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The GitHub repository where the script is kept.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "environment",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The pre-receive environment where the script is executed.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of enforcement for this hook.
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level.
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens",
+ "html": "Lists personal access tokens for all users, including admin users.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'",
+ "html": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.
\nIf the login name or email address is already associated with an account, the server will return a 422 response.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.
\nYou can delete any user account except your own.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/users/{username}/authorizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'",
+ "html": "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\" endpoint.
\nThis API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations",
+ "html": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "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.
\nThis API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "Uninstalling GitHub Apps and revoking an app's installation token are currently available for developers to preview. To access the new endpoint during the preview period, you must provide a custom media type in the Accept header:
\nUninstalls a GitHub App on a user, organization, or business account. You must use a JWT to access this endpoint.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/app/installations/{installation_id}/access_tokens",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "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.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants",
+ "html": "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 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. 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\"].
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/applications/{client_id}/grants/{access_token}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN",
+ "html": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication for this method, where the username is the OAuth application client_id and the password is its client_secret. You must also provide a valid token as :access_token and the grant for the token's owner will be deleted.
\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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/applications/{client_id}/tokens/{access_token}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
+ "html": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication when accessing it, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 when accessing it, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication for this method, where the username is the OAuth application client_id and the password is its client_secret.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/apps/{app_slug}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "app_slug",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG",
+ "html": "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 or an installation access token to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations",
+ "html": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "client_id": {
+ "description": "The OAuth app client key for which to create the token.
",
+ "maxLength": 20,
+ "type": "string",
+ "name": "client_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client key for which to create the token.",
+ "childParamsGroups": []
+ },
+ "client_secret": {
+ "description": "The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "create-a-new-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "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.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The OAuth app client key for which to create the token.
",
+ "maxLength": 20,
+ "type": "string",
+ "name": "client_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client key for which to create the token.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "client_secret"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "get-or-create-an-authorization-for-a-specific-app",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "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.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nA list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if returning an existing token",
+ "payload": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "client_secret"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "get-or-create-an-authorization-for-a-specific-app-and-fingerprint",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "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.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
",
+ "bodyParameters": [
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if returning an existing token",
+ "payload": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "add_scopes": {
+ "description": "A list of scopes to add to this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to add to this authorization.",
+ "childParamsGroups": []
+ },
+ "remove_scopes": {
+ "description": "A list of scopes to remove from this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to remove from this authorization.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "update-an-existing-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "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.\"
\nYou can only send one of these scope keys at a time.
",
+ "bodyParameters": [
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A list of scopes to add to this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to add to this authorization.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A list of scopes to remove from this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to remove from this authorization.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "The Codes of Conduct API is currently available for developers to preview.
\nThe Codes of Conduct API is currently available for developers to preview.
\nTo access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:
\nCreates 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 to create an attachment.
\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nLists all the emojis available to use on GitHub Enterprise Server.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/enterprise/settings/license",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license",
+ "html": "These statistics are cached and will be updated approximately every 10 minutes.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events",
+ "html": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/feeds",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds",
+ "html": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists",
+ "html": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Allows you to add a new gist with one or more files.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public",
+ "html": "List public gists sorted by most recently updated to least recently updated.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred",
+ "html": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments",
+ "html": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits",
+ "html": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks",
+ "html": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories",
+ "html": "List repositories that an app installation can access.
\nIndicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues",
+ "html": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
\nThe rendering mode.
",
+ "enum": [
+ "markdown",
+ "gfm"
+ ],
+ "default": "markdown",
+ "example": "markdown",
+ "type": "string",
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The rendering mode.",
+ "childParamsGroups": []
+ },
+ "context": {
+ "description": "The rendering mode.
",
+ "enum": [
+ "markdown",
+ "gfm"
+ ],
+ "default": "markdown",
+ "example": "markdown",
+ "type": "string",
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The rendering mode.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events",
+ "html": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications",
+ "html": "List all notifications for the current user, sorted by most recently updated.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Describes the last point that notifications were checked.
",
+ "type": "string",
+ "format": "date-time",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Describes the last point that notifications were checked.",
+ "childParamsGroups": []
+ },
+ "read": {
+ "description": "Whether the notification has been read.
",
+ "type": "boolean",
+ "name": "read",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the notification has been read.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "mark-notifications-as-read",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "205",
+ "httpStatusMessage": "Reset Content",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "descriptionHTML": "Describes the last point that notifications were checked.
",
+ "type": "string",
+ "format": "date-time",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Describes the last point that notifications were checked.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the notification has been read.
",
+ "type": "boolean",
+ "name": "read",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the notification has been read.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/notifications/threads/{thread_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Whether to block all notifications from a thread.
",
+ "default": false,
+ "type": "boolean",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to block all notifications from a thread.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "set-a-thread-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "descriptionHTML": "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.
\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.
",
+ "bodyParameters": [
+ {
+ "description": "Whether to block all notifications from a thread.
",
+ "default": false,
+ "type": "boolean",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to block all notifications from a thread.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 endpoint and set ignore to true.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/octocat",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "s",
+ "in": "query",
+ "description": "The words to show in Octocat's speech bubble",
+ "schema": {
+ "type": "string"
+ },
+ "required": false,
+ "descriptionHTML": "An organization ID. Only return organizations with an ID greater than this ID.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNew 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.
\nTo access these new parameters during the preview period, you must provide a custom media type in the Accept header:
\nTo 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.
\nBilling email address. This address is not publicized.
",
+ "name": "billing_email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Billing email address. This address is not publicized.",
+ "childParamsGroups": []
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name.
",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The company name.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The publicly visible email address.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address.",
+ "childParamsGroups": []
+ },
+ "twitter_username": {
+ "type": "string",
+ "description": "The Twitter username of the company.
",
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The Twitter username of the company.",
+ "childParamsGroups": []
+ },
+ "location": {
+ "type": "string",
+ "description": "The location.
",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The location.",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "The shorthand name of the company.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The shorthand name of the company.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the company.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the company.",
+ "childParamsGroups": []
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "description": "Toggles whether an organization can use organization projects.
",
+ "name": "has_organization_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether an organization can use organization projects.",
+ "childParamsGroups": []
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "description": "Toggles whether repositories that belong to the organization can use repository projects.
",
+ "name": "has_repository_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.",
+ "childParamsGroups": []
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "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
\nNote: 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,
+ "name": "members_can_create_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_internal_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_private_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_public_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.
",
+ "enum": [
+ "all",
+ "private",
+ "none"
+ ],
+ "name": "members_allowed_repository_creation_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "members_can_create_pages",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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`. ",
+ "childParamsGroups": []
+ },
+ "blog": {
+ "type": "string",
+ "example": "\"http://github.blog\"",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "description": "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.
\nTo access these new parameters during the preview period, you must provide a custom media type in the Accept header:
\nBilling email address. This address is not publicized.
",
+ "name": "billing_email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Billing email address. This address is not publicized.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The company name.
",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The company name.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The publicly visible email address.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The Twitter username of the company.
",
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The Twitter username of the company.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The location.
",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The location.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The shorthand name of the company.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The shorthand name of the company.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the company.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the company.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Toggles whether an organization can use organization projects.
",
+ "name": "has_organization_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether an organization can use organization projects.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Toggles whether repositories that belong to the organization can use repository projects.
",
+ "name": "has_repository_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "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
\nNote: 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,
+ "name": "members_can_create_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_internal_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_private_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_public_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.
",
+ "enum": [
+ "all",
+ "private",
+ "none"
+ ],
+ "name": "members_allowed_repository_creation_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "members_can_create_pages",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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`. ",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"http://github.blog\"",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "description": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events",
+ "html": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks",
+ "html": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "config"
+ ]
+ },
+ "example": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "create-an-organization-webhook",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42",
+ "html": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "example": "\"web\"",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"web\"",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "description": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation",
+ "html": "Enables an authenticated GitHub App to find the organization's installation information.
\nIndicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues",
+ "html": "List issues in an organization assigned to the authenticated user.
\nFilter members returned by their role. Can be one of:
\n* all - All members of the organization, regardless of role.
\n* admin - Organization owners.
\n* member - Non-owner organization members.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members",
+ "html": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Check if a user is, publicly or privately, a member of the organization.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME",
+ "html": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME",
+ "html": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has an active admin membership with organization",
+ "payload": "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "set-organization-membership-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\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.
",
+ "bodyParameters": [
+ {
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user was previously unaffiliated with organization",
+ "payload": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/outside_collaborators",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators",
+ "html": "List all users who are outside collaborators of an organization.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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\".
",
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "User is getting converted asynchronously"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "User was converted"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Response if user is the last owner of the organization",
+ "payload": "Removing a user from this list will remove them from all the organization's repositories.
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if user is a member of the organization",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nList all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nThe state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ },
+ "allow_downstream_configuration": {
+ "description": "Whether repositories can override enforcement.
",
+ "type": "boolean",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether repositories can override enforcement.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nFor pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
",
+ "bodyParameters": [
+ {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether repositories can override enforcement.
",
+ "type": "boolean",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether repositories can override enforcement.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nRemoves any overrides for this hook at the org level for this org.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Indicates the state of the projects to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nLists 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nCreates 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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members",
+ "html": "Members of an organization can choose to have their membership publicized or not.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nSpecifies 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.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos",
+ "html": "To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\nLists repositories for the specified organization.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ "homepage": {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "type": "boolean",
+ "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.
",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ "auto_init": {
+ "type": "boolean",
+ "description": "To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\nCreates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nA short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "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.
",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams",
+ "html": "Lists all teams in an organization that are visible to the authenticated user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ "maintainers": {
+ "type": "array of strings",
+ "description": "List GitHub IDs for organization members who will become team maintainers.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "maintainers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List GitHub IDs for organization members who will become team maintainers.",
+ "childParamsGroups": []
+ },
+ "repo_names": {
+ "type": "array of strings",
+ "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "repo_names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
+ "childParamsGroups": []
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. The options are:
\nFor 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
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ "permission": {
+ "type": "string",
+ "description": "The ID of a team to set as the parent team.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "admin",
+ "privacy": "closed"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "create-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "descriptionHTML": "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\".
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "List GitHub IDs for organization members who will become team maintainers.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "maintainers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List GitHub IDs for organization members who will become team maintainers.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "repo_names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The level of privacy this team should have. The options are:
\nFor 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
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The ID of a team to set as the parent team.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nFilters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nWhether or not this project can be seen by everyone.
",
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether or not this project can be seen by everyone.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nUpdates 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.
",
+ "bodyParameters": [
+ {
+ "description": "Whether or not this project can be seen by everyone.
",
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether or not this project can be seen by everyone.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nDeletes a project board. Returns a 404 Not Found status if projects are disabled.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/{project_id}/collaborators",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filters the collaborators by their affiliation. Can be one of:
\n* outside: Outside collaborators of a project that are not a member of the project's organization.
\n* direct: Collaborators with permissions to a project, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nLists 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "The permission to grant the collaborator.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "default": "write",
+ "example": "write",
+ "type": "string",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the collaborator.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nAdds 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.
",
+ "bodyParameters": [
+ {
+ "description": "The permission to grant the collaborator.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "default": "write",
+ "example": "write",
+ "type": "string",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the collaborator.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/projects/{project_id}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nRemoves a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/{project_id}/collaborators/{username}/permission",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nReturns 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe 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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThis API is under preview and subject to change.
"
+ },
+ {
+ "name": "reaction_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/reactions/42",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\nThe Codes of Conduct API is currently available for developers to preview.
\nThe name of the repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ "homepage": {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Updates the default branch for this repository.
",
+ "name": "default_branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Updates the default branch for this repository.",
+ "childParamsGroups": []
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "description": "To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\nThe name of the repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Updates the default branch for this repository.
",
+ "name": "default_branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Updates the default branch for this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "If an organization owner has configured the organization to prevent members from deleting organization owned repositories a member will get this response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees",
+ "html": "Checks if a user has permission to be assigned to an issue in this repository.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 of strings",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "required_pull_request_reviews",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.",
+ "childParamsGroups": [
+ {
+ "parentName": "required_pull_request_reviews",
+ "parentType": "object",
+ "id": "required_pull_request_reviews-object",
+ "params": [
+ {
+ "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 of strings",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "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\" in the GitHub Help documentation.
",
+ "name": "required_linear_history",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "allow_force_pushes": {
+ "type": "boolean or null",
+ "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\" in the GitHub Help documentation.\"
",
+ "nullable": true,
+ "name": "allow_force_pushes",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.\"",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "allow_deletions",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nSpecify 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 of strings",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "required_pull_request_reviews",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.",
+ "childParamsGroups": [
+ {
+ "parentName": "required_pull_request_reviews",
+ "parentType": "object",
+ "id": "required_pull_request_reviews-object",
+ "params": [
+ {
+ "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 of strings",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "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\" in the GitHub Help documentation.
",
+ "name": "required_linear_history",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean or null",
+ "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\" in the GitHub Help documentation.\"
",
+ "nullable": true,
+ "name": "allow_force_pushes",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.\"",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "allow_deletions",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 in the GitHub Help documentation.
\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 of strings",
+ "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nSpecify 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 of strings",
+ "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
\nProtected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ "contexts": {
+ "type": "array of strings",
+ "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 in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
",
+ "bodyParameters": [
+ {
+ "type": "boolean",
+ "description": "Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response",
+ "payload": "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 in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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 in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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 in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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 in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nProtected 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 in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\nProtected 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 in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\nProtected 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 in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\nProtected 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 in the GitHub Help documentation.
\nLists the people who have push access to this branch.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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 in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\nProtected 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 in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\nProtected 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 in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\nThe 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.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "default": "queued",
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ "started_at": {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "title",
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#output-object) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "actions": {
+ "type": "array of objects",
+ "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\" To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response for in_progress conclusion",
+ "payload": "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.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "default": "queued",
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "title",
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#output-object) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\" To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe name of the check. For example, \"code-coverage\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the check. For example, \"code-coverage\".",
+ "childParamsGroups": []
+ },
+ "details_url": {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL of the integrator's site that has the full details of the check.",
+ "childParamsGroups": []
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ "started_at": {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ "conclusion": {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#output-object-1) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "actions": {
+ "type": "array of objects",
+ "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 description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "The name of the check. For example, \"code-coverage\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the check. For example, \"code-coverage\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL of the integrator's site that has the full details of the check.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#output-object-1) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "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 description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nEnables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer",
+ "description": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nChanges 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. You must have admin permissions in the repository to set preferences for check suites.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer",
+ "description": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nThe Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nTriggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
\nFilter collaborators returned by their affiliation. Can be one of:
\n* outside: All outside collaborators of an organization-owned repository.
\n* direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators",
+ "html": "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.
\nTeam members will include the members of child teams.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "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.
\nTeam members will include the members of child teams.
"
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "permissions": {
+ "type": "string",
+ "example": "\"push\"",
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "description": "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.
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
",
+ "bodyParameters": [
+ {
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"push\"",
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "description": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has admin permissions",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments",
+ "html": "Comments are ordered by ascending ID.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions",
+ "html": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
"
+ },
+ {
+ "name": "path",
+ "description": "Only commits containing this file path will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only commits containing this file path will be returned.
"
+ },
+ {
+ "name": "author",
+ "description": "GitHub login or email address by which to filter by commit author.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "GitHub login or email address by which to filter by commit author.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits",
+ "html": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\nProtected 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 in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments",
+ "html": "Relative path of the file to comment on.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Relative path of the file to comment on.",
+ "childParamsGroups": []
+ },
+ "position": {
+ "type": "integer",
+ "description": "Line index in the diff to comment on.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Line index in the diff to comment on.",
+ "childParamsGroups": []
+ },
+ "line": {
+ "type": "integer",
+ "description": "Relative path of the file to comment on.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Relative path of the file to comment on.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Line index in the diff to comment on.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Line index in the diff to comment on.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls",
+ "html": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\nLists 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 endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nLists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\nUsers 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.
\nPage number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses",
+ "html": "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.
\nThe Codes of Conduct API is currently available for developers to preview.
\nThis method returns the contents of the repository's code of conduct file, if one is detected.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": ":branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/compare-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#compare-two-commits"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "commits"
+ },
+ "slug": "compare-two-commits",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 <USERNAME>:branch.
\nThe response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
\nWorking with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\n \"html_url\": \"https://github.com/octocat/Hello-World/compare/master...topic\",\n \"permalink_url\": \"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\n \"base_commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n },\n \"merge_base_commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n },\n \"status\": \"behind\",\n \"ahead_by\": 1,\n \"behind_by\": 2,\n \"total_commits\": 1,\n \"commits\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"sha\": \"bbcd538c8e72b8c175046e27cc8f907076331401\",\n \"filename\": \"file1.txt\",\n \"status\": \"added\",\n \"additions\": 103,\n \"deletions\": 21,\n \"changes\": 124,\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"patch\": \"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/contents/{path}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "path",
+ "description": "path+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "path+ parameter
"
+ },
+ {
+ "name": "ref",
+ "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path'\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@2.18/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-content",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-repository-content"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "get-repository-content",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nFiles and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\n\n- To get a repository's contents recursively, you can recursively get the tree.
\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.
\n- This API supports files up to 1 megabyte in size.
\n
\n\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\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\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\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.
\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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a file",
+ "payload": "{\n \"type\": \"file\",\n \"encoding\": \"base64\",\n \"size\": 5362,\n \"name\": \"README.md\",\n \"path\": \"README.md\",\n \"content\": \"encoded content ...\",\n \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a directory",
+ "payload": "[\n {\n \"type\": \"file\",\n \"size\": 625,\n \"name\": \"octokit.rb\",\n \"path\": \"lib/octokit.rb\",\n \"sha\": \"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"\n }\n },\n {\n \"type\": \"dir\",\n \"size\": 0,\n \"name\": \"octokit\",\n \"path\": \"lib/octokit\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\n \"download_url\": null,\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"html\": \"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a symlink",
+ "payload": "{\n \"type\": \"symlink\",\n \"target\": \"/path/to/symlink/target\",\n \"size\": 23,\n \"name\": \"some-symlink\",\n \"path\": \"bin/some-symlink\",\n \"sha\": \"452a98979c88e093d682cab404a3ec82babebb48\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a submodule",
+ "payload": "{\n \"type\": \"submodule\",\n \"submodule_git_url\": \"git://github.com/jquery/qunit.git\",\n \"size\": 0,\n \"name\": \"qunit\",\n \"path\": \"test/qunit\",\n \"sha\": \"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"url\": \"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\n \"git_url\": \"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"html_url\": \"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"download_url\": null,\n \"_links\": {\n \"git\": \"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"self\": \"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\n \"html\": \"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Found"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/contents/{path}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "path",
+ "description": "path+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "path+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n content: 'content'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n content: 'content'\n})\n
"
+ }
+ ],
+ "summary": "Create or update file contents",
+ "description": "Creates a new file or replaces an existing file in a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-or-update-file-contents",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-or-update-file-contents"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ "content": {
+ "type": "string",
+ "description": "Required. The new file content, using Base64 encoding.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new file content, using Base64 encoding.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "Required if you are updating a file. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ "branch": {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ "committer": {
+ "type": "object",
+ "description": "The person that committed the file. Default: the authenticated user.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The person that committed the file. Default: the authenticated user.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "create-or-update-file-contents",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "descriptionHTML": "Creates a new file or replaces an existing file in a repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Example for updating a file",
+ "payload": "{\n \"content\": {\n \"name\": \"hello.txt\",\n \"path\": \"notes/hello.txt\",\n \"sha\": \"a56507ed892d05a37c6d6128c260937ea4d287bd\",\n \"size\": 9,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"html_url\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\n \"git_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\n \"download_url\": \"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\n \"type\": \"file\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"git\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\n \"html\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"\n }\n },\n \"commit\": {\n \"sha\": \"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\n \"node_id\": \"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\n \"sha\": \"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\n \"sha\": \"da5a433788da5c255edad7979b328b67d79f53f6\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Example for creating a file",
+ "payload": "{\n \"content\": {\n \"name\": \"hello.txt\",\n \"path\": \"notes/hello.txt\",\n \"sha\": \"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\n \"size\": 9,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"html_url\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\n \"git_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\n \"download_url\": \"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\n \"type\": \"file\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"git\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\n \"html\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"\n }\n },\n \"commit\": {\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\n \"sha\": \"691272480426f78a0138979dd3ce63b77f706feb\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"sha\": \"1acc419d4d6a9ce985db7be48c6349a0475975b5\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The new file content, using Base64 encoding.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new file content, using Base64 encoding.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required if you are updating a file. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "The person that committed the file. Default: the authenticated user.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The person that committed the file. Default: the authenticated user.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "description": "The author of the file. Default: The committer or the authenticated user if you omit committer.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/contents/{path}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "path",
+ "description": "path+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "path+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n sha: 'sha'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Delete a file",
+ "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-file",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-file"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "Required. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ "branch": {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the committer.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the author.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "message",
+ "sha"
+ ]
+ },
+ "example": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "delete-a-file",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
\nThe author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
\nYou must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"content\": null,\n \"commit\": {\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\n \"sha\": \"691272480426f78a0138979dd3ce63b77f706feb\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"sha\": \"1acc419d4d6a9ce985db7be48c6349a0475975b5\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "object containing information about the committer.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the committer.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "description": "object containing information about the author.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the author.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/contributors",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "anon",
+ "description": "Set to `1` or `true` to include anonymous contributors in results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Set to 1 or true to include anonymous contributors in results.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository contributors",
+ "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-contributors",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-contributors"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-contributors",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if repository contains content",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"contributions\": 32\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if repository is empty"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "sha",
+ "description": "The SHA recorded at creation time.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The SHA recorded at creation time.
"
+ },
+ {
+ "name": "ref",
+ "description": "The name of the ref. This can be a branch, tag, or SHA.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The name of the ref. This can be a branch, tag, or SHA.
"
+ },
+ {
+ "name": "task",
+ "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The name of the task for the deployment (e.g., deploy or deploy:migrations).
"
+ },
+ {
+ "name": "environment",
+ "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The name of the environment that was deployed to (e.g., staging or production).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List deployments",
+ "description": "Simple filtering of deployments is available via query parameters:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-deployments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "list-deployments",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Simple filtering of deployments is available via query parameters:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/deployments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Create a deployment",
+ "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deployment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Required. The ref to deploy. This can be a branch, tag, or SHA.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.",
+ "childParamsGroups": []
+ },
+ "task": {
+ "type": "string",
+ "description": "Specifies a task to execute (e.g., deploy or deploy:migrations).
",
+ "default": "deploy",
+ "name": "task",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "auto_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
+ "childParamsGroups": []
+ },
+ "required_contexts": {
+ "type": "array of strings",
+ "description": "The status 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"
+ },
+ "name": "required_contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [status](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
+ "childParamsGroups": []
+ },
+ "payload": {
+ "type": "string",
+ "description": "JSON payload with extra information about the deployment.
",
+ "default": "",
+ "name": "payload",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "JSON payload with extra information about the deployment.",
+ "childParamsGroups": []
+ },
+ "environment": {
+ "type": "string",
+ "description": "Name for the target deployment environment (e.g., production, staging, qa).
",
+ "default": "production",
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string or null",
+ "description": "Short description of the deployment.
",
+ "default": "",
+ "nullable": true,
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Short description of the deployment.",
+ "childParamsGroups": []
+ },
+ "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
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": false,
+ "name": "transient_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "production_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "created_at": {
+ "type": "string",
+ "example": "\"1776-07-04T00:00:00.000-07:52\"",
+ "name": "created_at",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "create-a-deployment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
\nThe environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
\nThe auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
\nBy default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
\nThe payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
\nThe task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
\nUsers with repo or repo_deployment scopes can create a deployment for a given ref.
\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\n\n- Auto-merge option is enabled in the repository
\n- Topic branch does not include the latest changes on the base branch, which is
master in the response example \n- There are no merge conflicts
\n
\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\n\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
\n\nThis error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The ref to deploy. This can be a branch, tag, or SHA.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Specifies a task to execute (e.g., deploy or deploy:migrations).
",
+ "default": "deploy",
+ "name": "task",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
",
+ "default": true,
+ "name": "auto_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The status 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"
+ },
+ "name": "required_contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [status](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "JSON payload with extra information about the deployment.
",
+ "default": "",
+ "name": "payload",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "JSON payload with extra information about the deployment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Name for the target deployment environment (e.g., production, staging, qa).
",
+ "default": "production",
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "description": "Short description of the deployment.
",
+ "default": "",
+ "nullable": true,
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Short description of the deployment.",
+ "childParamsGroups": []
+ },
+ {
+ "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
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": false,
+ "name": "transient_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "production_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"1776-07-04T00:00:00.000-07:52\"",
+ "name": "created_at",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Simple example",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Advanced example",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Merged branch response",
+ "payload": "{\n \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Merge conflict response",
+ "payload": "{\n \"message\": \"Conflict merging master into topic-branch\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Failed commit status checks",
+ "payload": "{\n \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a deployment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-deployment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ },
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "get-a-deployment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List deployment statuses",
+ "description": "Users with pull access can view deployment statuses for a deployment:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployment-statuses",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-deployment-statuses"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```",
+ "html": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.
\nTo access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:
\napplication/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.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "list-deployment-statuses",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with pull access can view deployment statuses for a deployment:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\n \"id\": 1,\n \"node_id\": \"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\n \"state\": \"success\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"description\": \"Deployment finished successfully.\",\n \"environment\": \"production\",\n \"target_url\": \"https://example.com/deployment/42/output\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"deployment_url\": \"https://api.github.com/repos/octocat/example/deployments/42\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"environment_url\": \"https://test-branch.lab.acme.com\",\n \"log_url\": \"https://example.com/deployment/42/output\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n state: 'state'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n state: 'state'\n})\n
"
+ }
+ ],
+ "summary": "Create a deployment status",
+ "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deployment-status"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "Required. 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 custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json 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"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
+ "childParamsGroups": []
+ },
+ "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": "",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "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: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "log_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the status. The maximum description length is 140 characters.
",
+ "default": "",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status. The maximum description length is 140 characters.",
+ "childParamsGroups": []
+ },
+ "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 custom media type.
",
+ "enum": [
+ "production",
+ "staging",
+ "qa"
+ ],
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type.",
+ "childParamsGroups": []
+ },
+ "environment_url": {
+ "type": "string",
+ "description": "Sets the URL for accessing your environment. Default: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "environment_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "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
\nNote: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "auto_inactive",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```",
+ "html": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.
\nTo access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:
\napplication/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.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "create-a-deployment-status",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
\nGitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. 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 custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json 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"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
+ "childParamsGroups": []
+ },
+ {
+ "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": "",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "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: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "log_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the status. The maximum description length is 140 characters.
",
+ "default": "",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status. The maximum description length is 140 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "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 custom media type.
",
+ "enum": [
+ "production",
+ "staging",
+ "qa"
+ ],
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Sets the URL for accessing your environment. Default: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "environment_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "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
\nNote: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "auto_inactive",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\n \"id\": 1,\n \"node_id\": \"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\n \"state\": \"success\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"description\": \"Deployment finished successfully.\",\n \"environment\": \"production\",\n \"target_url\": \"https://example.com/deployment/42/output\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"deployment_url\": \"https://api.github.com/repos/octocat/example/deployments/42\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"environment_url\": \"https://test-branch.lab.acme.com\",\n \"log_url\": \"https://example.com/deployment/42/output\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ },
+ {
+ "name": "status_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n status_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n status_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a deployment status",
+ "description": "Users with pull access can view a deployment status for a deployment:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-deployment-status"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ },
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```",
+ "html": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.
\nTo access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:
\napplication/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.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "get-a-deployment-status",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with pull access can view a deployment status for a deployment:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\n \"id\": 1,\n \"node_id\": \"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\n \"state\": \"success\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"description\": \"Deployment finished successfully.\",\n \"environment\": \"production\",\n \"target_url\": \"https://example.com/deployment/42/output\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"deployment_url\": \"https://api.github.com/repos/octocat/example/deployments/42\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"environment_url\": \"https://test-branch.lab.acme.com\",\n \"log_url\": \"https://example.com/deployment/42/output\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository events",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repository-events"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-repository-events",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/forks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "The sort order. Can be either newest, oldest, or stargazers.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List forks",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-forks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "forks"
+ },
+ "slug": "list-forks",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "forks",
+ "subcategoryLabel": "Forks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": true,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/forks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world',\n organization: 'organization'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world',\n organization: 'organization'\n})\n
"
+ }
+ ],
+ "summary": "Create a fork",
+ "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://github.com/contact) or [GitHub Enterprise Server Premium Support](https://premium.githubsupport.com).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-fork"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "organization": {
+ "type": "string",
+ "description": "Optional parameter to specify the organization name if forking into an organization.
",
+ "name": "organization",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Optional parameter to specify the organization name if forking into an organization.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "forks"
+ },
+ "slug": "create-a-fork",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "forks",
+ "subcategoryLabel": "Forks",
+ "notes": [],
+ "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Optional parameter to specify the organization name if forking into an organization.
",
+ "name": "organization",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Optional parameter to specify the organization name if forking into an organization.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/blobs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/blobs', {\n owner: 'octocat',\n repo: 'hello-world',\n content: 'content'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/blobs', {\n owner: 'octocat',\n repo: 'hello-world',\n content: 'content'\n})\n
"
+ }
+ ],
+ "summary": "Create a blob",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-blob"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The new blob's content.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blob's content.",
+ "childParamsGroups": []
+ },
+ "encoding": {
+ "type": "string",
+ "description": "The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.
",
+ "default": "utf-8",
+ "name": "encoding",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "blobs"
+ },
+ "slug": "create-a-blob",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "blobs",
+ "subcategoryLabel": "Blobs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The new blob's content.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blob's content.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.
",
+ "default": "utf-8",
+ "name": "encoding",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\n \"sha\": \"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "file_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/blobs/{file_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n file_sha: 'file_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/blobs/{file_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n file_sha: 'file_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a blob",
+ "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-blob"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "blobs"
+ },
+ "slug": "get-a-blob",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "blobs",
+ "subcategoryLabel": "Blobs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The content in the response will always be Base64 encoded.
\nNote: This API supports blobs up to 100 megabytes in size.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"content\": \"Q29udGVudCBvZiB0aGUgYmxvYg==\",\n \"encoding\": \"base64\",\n \"url\": \"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\n \"sha\": \"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\n \"size\": 19,\n \"node_id\": \"Q29udGVudCBvZiB0aGUgYmxvYg==\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n message: 'message',\n tree: 'tree'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n message: 'message',\n tree: 'tree'\n})\n
"
+ }
+ ],
+ "summary": "Create a commit",
+ "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-commit"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The commit message
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message",
+ "childParamsGroups": []
+ },
+ "tree": {
+ "type": "string",
+ "description": "Required. The SHA of the tree object this commit points to
",
+ "name": "tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the tree object this commit points to",
+ "childParamsGroups": []
+ },
+ "parents": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "parents",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "signature": {
+ "type": "string",
+ "description": "The PGP signature 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 to create signed commits.
",
+ "name": "signature",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "message",
+ "tree"
+ ]
+ },
+ "example": {
+ "message": "my commit message",
+ "author": {
+ "name": "Mona Octocat",
+ "email": "octocat@github.com",
+ "date": "2008-07-09T16:13:30+12:00"
+ },
+ "parents": [
+ "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
+ ],
+ "tree": "827efc6d56897b048c772eb4087f854f46256132",
+ "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "commits"
+ },
+ "slug": "create-a-commit",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\n \"sha\": \"827efc6d56897b048c772eb4087f854f46256132\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\n \"sha\": \"7d1b31e74ee336d15cbd21741bc88a537ed063a0\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The commit message
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA of the tree object this commit points to
",
+ "name": "tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the tree object this commit points to",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "parents",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "string",
+ "description": "The PGP signature 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 to create signed commits.
",
+ "name": "signature",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "commit_sha+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/commits/{commit_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/commits/{commit_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a commit",
+ "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-commit"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "commits"
+ },
+ "slug": "get-a-commit",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"added readme, because im a good github citizen\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\n \"sha\": \"691272480426f78a0138979dd3ce63b77f706feb\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"sha\": \"1acc419d4d6a9ce985db7be48c6349a0475975b5\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/refs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/refs', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/refs', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Create a reference",
+ "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-reference"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "Required. The SHA1 value for this reference.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value for this reference.",
+ "childParamsGroups": []
+ },
+ "key": {
+ "type": "string",
+ "example": "\"refs/heads/newbranch\"",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "ref",
+ "sha"
+ ]
+ },
+ "example": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "create-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA1 value for this reference.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value for this reference.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"refs/heads/newbranch\"",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"ref\": \"refs/heads/featureA\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"aa218f56b14c9653891f9e74264a383fa43fefbd\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/refs/{namespace}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/refs/{namespace}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/refs/{namespace}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get all references",
+ "description": "Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-single-pull-request) to trigger a merge commit creation. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.18/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\n```\nGET /repos/octocat/Hello-World/git/refs\n```\n\nYou can also request a sub-namespace. For example, to get all the tag references, you can call:\n\n```\nGET /repos/octocat/Hello-World/git/refs/tags\n```",
+ "operationId": "git/get-all-refs",
+ "tags": [
+ "git"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#list-references"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "get-all-references",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags. If there are no references to list, a 404 is returned.
\nNote: You need to explicitly request a pull request to trigger a merge commit creation. For more information, see \"Checking mergeability of pull requests\".
\nGET /repos/octocat/Hello-World/git/refs\n
\nYou can also request a sub-namespace. For example, to get all the tag references, you can call:
\nGET /repos/octocat/Hello-World/git/refs/tags\n
"
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Update a reference",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/update-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#update-a-reference"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "description": "Required. The SHA1 value to set this reference to
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value to set this reference to",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "force",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "sha"
+ ]
+ },
+ "example": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "update-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The SHA1 value to set this reference to
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value to set this reference to",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "force",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"ref\": \"refs/heads/featureA\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"aa218f56b14c9653891f9e74264a383fa43fefbd\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Delete a reference",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/delete-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#delete-a-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "delete-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/tags",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/tags', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag',\n message: 'message',\n object: 'object',\n type: 'type'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/tags', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag',\n message: 'message',\n object: 'object',\n type: 'type'\n})\n
"
+ }
+ ],
+ "summary": "Create a tag object",
+ "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-tag-object"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag": {
+ "type": "string",
+ "description": "Required. The tag's name. This is typically a version (e.g., \"v0.0.1\").
",
+ "name": "tag",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. The tag message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag message.",
+ "childParamsGroups": []
+ },
+ "object": {
+ "type": "string",
+ "description": "Required. The SHA of the git object this is tagging.
",
+ "name": "object",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the git object this is tagging.",
+ "childParamsGroups": []
+ },
+ "type": {
+ "type": "string",
+ "description": "Required. The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
",
+ "enum": [
+ "commit",
+ "tree",
+ "blob"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.",
+ "childParamsGroups": []
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "tagger",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "An object with information about the individual creating the tag.",
+ "childParamsGroups": [
+ {
+ "parentName": "tagger",
+ "parentType": "object",
+ "id": "tagger-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author of the tag
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "tags"
+ },
+ "slug": "create-a-tag-object",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "tags",
+ "subcategoryLabel": "Tags",
+ "notes": [],
+ "descriptionHTML": "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 the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"node_id\": \"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\n \"tag\": \"v0.0.1\",\n \"sha\": \"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"message\": \"initial version\",\n \"tagger\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\",\n \"date\": \"2014-11-07T22:01:45Z\"\n },\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"\n },\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The tag's name. This is typically a version (e.g., \"v0.0.1\").
",
+ "name": "tag",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The tag message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA of the git object this is tagging.
",
+ "name": "object",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the git object this is tagging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
",
+ "enum": [
+ "commit",
+ "tree",
+ "blob"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.",
+ "childParamsGroups": []
+ },
+ {
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "tagger",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "An object with information about the individual creating the tag.",
+ "childParamsGroups": [
+ {
+ "parentName": "tagger",
+ "parentType": "object",
+ "id": "tagger-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author of the tag
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "tag_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/tags/{tag_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_sha: 'tag_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/tags/{tag_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_sha: 'tag_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a tag",
+ "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-tag"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "tags"
+ },
+ "slug": "get-a-tag",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "tags",
+ "subcategoryLabel": "Tags",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"node_id\": \"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\n \"tag\": \"v0.0.1\",\n \"sha\": \"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"message\": \"initial version\",\n \"tagger\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\",\n \"date\": \"2014-11-07T22:01:45Z\"\n },\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"\n },\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/trees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/trees', {\n owner: 'octocat',\n repo: 'hello-world',\n tree: [\n {\n path: 'path',\n mode: 'mode',\n type: 'type',\n sha: 'sha',\n content: 'content'\n }\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/trees', {\n owner: 'octocat',\n repo: 'hello-world',\n tree: [\n {\n path: 'path',\n mode: 'mode',\n type: 'type',\n sha: 'sha',\n content: 'content'\n }\n ]\n})\n
"
+ }
+ ],
+ "summary": "Create a tree",
+ "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@2.18/rest/reference/git#update-a-reference).\"",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-tree"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tree": {
+ "type": "array of objects",
+ "description": "Required. 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.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "type": {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "name": "tree",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.",
+ "childParamsGroups": [
+ {
+ "parentName": "tree",
+ "parentType": "items",
+ "id": "tree-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "The file referenced in the tree.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ {
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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.
",
+ "name": "base_tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "tree"
+ ]
+ },
+ "example": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "trees"
+ },
+ "slug": "create-a-tree",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "trees",
+ "subcategoryLabel": "Trees",
+ "notes": [],
+ "descriptionHTML": "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.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"tree\": [\n {\n \"path\": \"file.rb\",\n \"mode\": \"100644\",\n \"type\": \"blob\",\n \"size\": 132,\n \"sha\": \"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"\n }\n ],\n \"truncated\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "array of objects",
+ "description": "Required. 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.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "type": {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "name": "tree",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.",
+ "childParamsGroups": [
+ {
+ "parentName": "tree",
+ "parentType": "items",
+ "id": "tree-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "The file referenced in the tree.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ {
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "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.
",
+ "name": "base_tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "tree_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "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.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/trees/{tree_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/trees/{tree_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a tree",
+ "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-tree"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "trees"
+ },
+ "slug": "get-a-tree",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "trees",
+ "subcategoryLabel": "Trees",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\n \"tree\": [\n {\n \"path\": \"file.rb\",\n \"mode\": \"100644\",\n \"type\": \"blob\",\n \"size\": 30,\n \"sha\": \"44b4fc6d56897b048c772eb4087f854f46256132\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"\n },\n {\n \"path\": \"subdir\",\n \"mode\": \"040000\",\n \"type\": \"tree\",\n \"sha\": \"f484d249c660418515fb01c2b9662073663c242e\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"\n },\n {\n \"path\": \"exec_file\",\n \"mode\": \"100755\",\n \"type\": \"blob\",\n \"size\": 75,\n \"sha\": \"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"\n }\n ],\n \"truncated\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response recursively retrieving a tree",
+ "payload": "{\n \"sha\": \"fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"tree\": [\n {\n \"path\": \"subdir/file.txt\",\n \"mode\": \"100644\",\n \"type\": \"blob\",\n \"size\": 132,\n \"sha\": \"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"\n }\n ],\n \"truncated\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository webhooks",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-webhooks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-webhooks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "list-repository-webhooks",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n token: 'token',\n digest: 'digest'\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n token: 'token',\n digest: 'digest'\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a repository webhook",
+ "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-webhook"
+ },
+ "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.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.",
+ "childParamsGroups": []
+ },
+ "config": {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "token": {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "config"
+ ]
+ },
+ "example": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "create-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Use web to create a webhook. Default: web. This parameter only accepts the value web.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "token": {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a repository webhook",
+ "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "get-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n address: 'address',\n room: 'room'\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n address: 'address',\n room: 'room'\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a repository webhook",
+ "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-repository-webhook"
+ },
+ "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.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "address": {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "room": {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for. This replaces the entire array of events.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.",
+ "childParamsGroups": []
+ },
+ "add_events": {
+ "type": "array of strings",
+ "description": "Determines a list of events to be added to the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ "remove_events": {
+ "type": "array of strings",
+ "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "update-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "address": {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "room": {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for. This replaces the entire array of events.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines a list of events to be added to the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository webhook",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "delete-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/pings', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/pings', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Ping a repository webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.18/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#ping-a-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "ping-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This will trigger a ping event to be sent to the hook.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/tests', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/tests', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Test the push repository webhook",
+ "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/test-push-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#test-the-push-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "test-the-push-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nNote: Previously /repos/:owner/:repo/hooks/:hook_id/test
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/installation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/installation', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/installation', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a repository installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-repo-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-a-repository-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-a-repository-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"account\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"html_url\": \"https://github.com/github\",\n \"followers_url\": \"https://api.github.com/users/github/followers\",\n \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"repository_selection\": \"all\",\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"created_at\": \"2018-02-09T20:51:14Z\",\n \"updated_at\": \"2018-02-09T20:51:14Z\",\n \"single_file_name\": \"config.yml\",\n \"app_slug\": \"github-actions\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/invitations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/invitations', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/invitations', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository invitations",
+ "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-invitations"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "list-repository-invitations",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\",\n \"node_id\": \"MDQ6VXNlcjE=\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42,\n permissions: 'permissions'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42,\n permissions: 'permissions'\n})\n
"
+ }
+ ],
+ "summary": "Update a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-repository-invitation"
+ },
+ "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"
+ ],
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "update-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "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"
+ ],
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-repository-invitation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "delete-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "assignee",
+ "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
"
+ },
+ {
+ "name": "creator",
+ "description": "The user that created the issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "The user that created the issue.
"
+ },
+ {
+ "name": "mentioned",
+ "description": "A user that's mentioned in the issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A user that's mentioned in the issue.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository issues",
+ "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#list-repository-issues"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "list-repository-issues",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Create an issue",
+ "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#create-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ "assignee": {
+ "type": "string or null",
+ "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
",
+ "nullable": true,
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**_",
+ "childParamsGroups": []
+ },
+ "milestone": {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ "labels": {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._",
+ "childParamsGroups": []
+ },
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "example": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "create-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "descriptionHTML": "Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
",
+ "nullable": true,
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**_",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"closed_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Either asc or desc. Ignored without the sort parameter.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List issue comments for a repository",
+ "description": "By default, Issue Comments are ordered by ascending ID.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-comments-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "list-issue-comments-for-a-repository",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-an-issue-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "get-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#update-an-issue-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Me too"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "update-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#delete-an-issue-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "delete-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for an issue comment",
+ "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@2.18/rest/reference/issues#comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-an-issue-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-an-issue-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to an issue comment.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for an issue comment",
+ "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@2.18/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-an-issue-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the issue comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-an-issue-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the issue comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List issue events for a repository",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-events-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "events"
+ },
+ "slug": "list-issue-events-for-a-repository",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"issue\": {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "event_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/events/{event_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n event_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/events/{event_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n event_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an issue event",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-event",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-an-issue-event"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "events"
+ },
+ "slug": "get-an-issue-event",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"issue\": {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an issue",
+ "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#get-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "get-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"closed_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Update an issue",
+ "description": "Issue owners and users with push access can edit an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#update-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ "assignee": {
+ "type": "string",
+ "description": "Login for the user that this issue should be assigned to. This field is deprecated.
",
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "State of the issue. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of the issue. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "milestone": {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ "labels": {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "state": "open",
+ "labels": [
+ "bug"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "update-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "descriptionHTML": "Issue owners and users with push access can edit an issue.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Login for the user that this issue should be assigned to. This field is deprecated.
",
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "State of the issue. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of the issue. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"closed_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Add assignees to an issue",
+ "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#add-assignees-to-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "assignees"
+ },
+ "slug": "add-assignees-to-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "assignees",
+ "subcategoryLabel": "Assignees",
+ "notes": [],
+ "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Remove assignees from an issue",
+ "description": "Removes one or more assignees from an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#remove-assignees-from-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "assignees"
+ },
+ "slug": "remove-assignees-from-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "assignees",
+ "subcategoryLabel": "Assignees",
+ "notes": [],
+ "descriptionHTML": "Removes one or more assignees from an issue.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List issue comments",
+ "description": "Issue Comments are ordered by ascending ID.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-comments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "list-issue-comments",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Issue Comments are ordered by ascending ID.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create an issue comment",
+ "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-an-issue-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Me too"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "create-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List issue events",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-events"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "events"
+ },
+ "slug": "list-issue-events",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List labels for an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-on-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-labels-for-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "list-labels-for-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Add labels to an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#add-labels-to-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "labels"
+ ]
+ },
+ "example": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "add-labels-to-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Set labels for an issue",
+ "description": "Removes any previous labels and sets the new labels for an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/set-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#set-labels-for-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "set-labels-for-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Remove all labels from an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-all-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#remove-all-labels-from-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "remove-all-labels-from-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n name: 'name'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Remove a label from an issue",
+ "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#remove-a-label-from-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "remove-a-label-from-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n lock_reason: 'lock_reason'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n lock_reason: 'lock_reason'\n})\n
"
+ }
+ ],
+ "summary": "Lock an issue",
+ "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/lock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#lock-an-issue"
+ },
+ "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"
+ ],
+ "name": "lock_reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "lock-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "Users with push access can lock an issue or pull request's conversation.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "bodyParameters": [
+ {
+ "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"
+ ],
+ "name": "lock_reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Unlock an issue",
+ "description": "Users with push access can unlock an issue's conversation.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/unlock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#unlock-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "unlock-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with push access can unlock an issue's conversation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for an issue",
+ "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@2.18/rest/reference/issues).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-an-issue",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to an issue.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for an issue",
+ "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@2.18/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the issue.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-an-issue",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to an issue. A response with a Status: 200 OK means that you already added the reaction type to this issue.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the issue.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'mockingbird'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'mockingbird'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List timeline events for an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-timeline",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-timeline-events-for-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mockingbird",
+ "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```",
+ "html": "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 for full details. To access the API you must provide a custom media type in the Accept header:
\napplication/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).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "timeline"
+ },
+ "slug": "list-timeline-events-for-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "timeline",
+ "subcategoryLabel": "Timeline",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List deploy keys",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deploy-keys",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-deploy-keys"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "list-deploy-keys",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})\n
"
+ }
+ ],
+ "summary": "Create a deploy key",
+ "description": "You can create a read-only deploy key.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deploy-key"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "A name for the key.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A name for the key.",
+ "childParamsGroups": []
+ },
+ "key": {
+ "type": "string",
+ "description": "Required. The contents of the key.
",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the key.",
+ "childParamsGroups": []
+ },
+ "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.
\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\" and \"Permission levels for a user account repository.\"
",
+ "name": "read_only",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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/).\"",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "key"
+ ]
+ },
+ "example": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "create-a-deploy-key",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "descriptionHTML": "You can create a read-only deploy key.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "A name for the key.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A name for the key.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The contents of the key.
",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the key.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\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\" and \"Permission levels for a user account repository.\"
",
+ "name": "read_only",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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/).\"",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a deploy key",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-deploy-key"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "get-a-deploy-key",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a deploy key",
+ "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-deploy-key"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "delete-a-deploy-key",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List labels for a repository",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-labels-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "list-labels-for-a-repository",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Create a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-a-label"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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/).",
+ "childParamsGroups": []
+ },
+ "color": {
+ "type": "string",
+ "description": "The hexadecimal color code for the label, without the leading #.
",
+ "name": "color",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the label.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the label.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "create-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. 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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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/).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The hexadecimal color code for the label, without the leading #.
",
+ "name": "color",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the label.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the label.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Get a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-a-label"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "get-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Delete a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#delete-a-label"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "delete-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/languages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/languages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/languages', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository languages",
+ "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-languages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-languages"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-languages",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"C\": 78769,\n \"Python\": 7769\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/license",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/license', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/license', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the license for a repository",
+ "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/licenses/#get-the-license-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "licenses",
+ "subcategory": null
+ },
+ "slug": "get-the-license-for-a-repository",
+ "category": "licenses",
+ "categoryLabel": "Licenses",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"name\": \"LICENSE\",\n \"path\": \"LICENSE\",\n \"sha\": \"401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"size\": 1077,\n \"url\": \"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\n \"html_url\": \"https://github.com/benbalter/gman/blob/master/LICENSE\",\n \"git_url\": \"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"download_url\": \"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\n \"type\": \"file\",\n \"content\": \"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\n \"encoding\": \"base64\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\n \"git\": \"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"html\": \"https://github.com/benbalter/gman/blob/master/LICENSE\"\n },\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/merges",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/merges', {\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/merges', {\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})\n
"
+ }
+ ],
+ "summary": "Merge a branch",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#merge-a-branch"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "string",
+ "description": "Required. The name of the base branch that the head will be merged into.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the base branch that the head will be merged into.",
+ "childParamsGroups": []
+ },
+ "head": {
+ "type": "string",
+ "description": "Required. The head to merge. This can be a branch name or a commit SHA1.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.",
+ "childParamsGroups": []
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Commit message to use for the merge commit. If omitted, a default message will be used.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "base",
+ "head"
+ ]
+ },
+ "example": {
+ "base": "master",
+ "head": "cool_feature",
+ "commit_message": "Shipped cool_feature!"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "merging"
+ },
+ "slug": "merge-a-branch",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "merging",
+ "subcategoryLabel": "Merging",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the base branch that the head will be merged into.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the base branch that the head will be merged into.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The head to merge. This can be a branch name or a commit SHA1.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Commit message to use for the merge commit. If omitted, a default message will be used.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ],\n \"stats\": {\n \"additions\": 104,\n \"deletions\": 4,\n \"total\": 108\n },\n \"files\": [\n {\n \"filename\": \"file1.txt\",\n \"additions\": 10,\n \"deletions\": 2,\n \"changes\": 12,\n \"status\": \"modified\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\n \"patch\": \"@@ -29,7 +29,7 @@\\n.....\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Missing base response",
+ "payload": "{\n \"message\": \"Base does not exist\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Missing head response",
+ "payload": "{\n \"message\": \"Head does not exist\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Merge conflict response",
+ "payload": "{\n \"message\": \"Merge Conflict\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/milestones",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "The state of the milestone. Either open, closed, or all.
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Either `due_on` or `completeness`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "due_on",
+ "completeness"
+ ],
+ "default": "due_on"
+ },
+ "descriptionHTML": "What to sort results by. Either due_on or completeness.
"
+ },
+ {
+ "name": "direction",
+ "description": "The direction of the sort. Either `asc` or `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "asc"
+ },
+ "descriptionHTML": "The direction of the sort. Either asc or desc.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List milestones",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-milestones",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-milestones"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "list-milestones",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/milestones",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Create a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-a-milestone"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ "due_on": {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "example": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "create-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-a-milestone"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "get-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Update a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#update-a-milestone"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ "due_on": {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "update-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#delete-a-milestone"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "delete-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List labels for issues in a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-for-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-labels-for-issues-in-a-milestone"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "list-labels-for-issues-in-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/notifications",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "all",
+ "description": "If `true`, show notifications marked as read.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ },
+ "descriptionHTML": "If true, show notifications marked as read.
"
+ },
+ {
+ "name": "participating",
+ "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ },
+ "descriptionHTML": "If true, only shows notifications in which the user is directly participating or mentioned.
"
+ },
+ {
+ "name": "since",
+ "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "before",
+ "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository notifications for the authenticated user",
+ "description": "List all notifications for the current user.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-notifications-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repository-notifications-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "list-repository-notifications-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all notifications for the current user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": \"1\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"subject\": {\n \"title\": \"Greetings\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n \"type\": \"Issue\"\n },\n \"reason\": \"subscribed\",\n \"unread\": true,\n \"updated_at\": \"2014-11-07T22:01:45Z\",\n \"last_read_at\": \"2014-11-07T22:01:45Z\",\n \"url\": \"https://api.github.com/notifications/threads/1\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/notifications",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world',\n last_read_at: 'last_read_at'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world',\n last_read_at: 'last_read_at'\n})\n
"
+ }
+ ],
+ "summary": "Mark repository notifications as read",
+ "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](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 Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-repo-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#mark-repository-notifications-as-read"
+ },
+ "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 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "mark-repository-notifications-as-read",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "descriptionHTML": "Marks all notifications in a repository as \"read\" removes them from the default view on GitHub Enterprise Server. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server 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 endpoint and pass the query parameter all=false.
",
+ "bodyParameters": [
+ {
+ "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 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a GitHub Enterprise Server Pages site",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-github-pages-site"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "get-a-github-enterprise-server-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages\",\n \"status\": \"built\",\n \"cname\": \"developer.github.com\",\n \"custom_404\": false,\n \"html_url\": \"https://developer.github.com\",\n \"source\": {\n \"branch\": \"master\",\n \"path\": \"/\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a GitHub Pages site",
+ "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-github-pages-site"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The source branch and directory used to publish your Pages site.",
+ "properties": {
+ "source": {
+ "type": "object",
+ "description": "Required. The source branch and directory used to publish your Pages site.
",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "branch"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The source branch and directory used to publish your Pages site.",
+ "childParamsGroups": [
+ {
+ "parentName": "source",
+ "parentType": "object",
+ "id": "source-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "source"
+ ]
+ },
+ "example": {
+ "source": {
+ "branch": "master",
+ "path": "/docs"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "switcheroo",
+ "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
+ "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.switcheroo-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "mister-fantastic",
+ "note": "The GitHub Pages API contains two additional fields in responses, which developers can preview: `html_url` and `source`. To see these two new fields, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mister-fantastic-preview+json\n```",
+ "html": "The GitHub Pages API contains two additional fields in responses, which developers can preview: html_url and source. To see these two new fields, you must provide a custom media type in the Accept header:
\napplication/vnd.github.mister-fantastic-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "create-a-github-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages\",\n \"status\": \"built\",\n \"cname\": \"developer.github.com\",\n \"custom_404\": false,\n \"html_url\": \"https://developer.github.com\",\n \"source\": {\n \"branch\": \"master\",\n \"path\": \"/\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "object",
+ "description": "Required. The source branch and directory used to publish your Pages site.
",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "branch"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The source branch and directory used to publish your Pages site.",
+ "childParamsGroups": [
+ {
+ "parentName": "source",
+ "parentType": "object",
+ "id": "source-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: 'source'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: 'source'\n})\n
"
+ }
+ ],
+ "summary": "Update information about a GitHub Pages site",
+ "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-information-about-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-information-about-a-github-pages-site"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ }
+ ],
+ "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"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\"`.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "source": "master /docs"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "mister-fantastic",
+ "note": "The GitHub Pages API contains two additional fields in responses, which developers can preview: `html_url` and `source`. To see these two new fields, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mister-fantastic-preview+json\n```",
+ "html": "The GitHub Pages API contains two additional fields in responses, which developers can preview: html_url and source. To see these two new fields, you must provide a custom media type in the Accept header:
\napplication/vnd.github.mister-fantastic-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "update-information-about-a-github-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.
",
+ "bodyParameters": [
+ {
+ "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"
+ ]
+ }
+ ],
+ "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"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\"`.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a GitHub Enterprise Server Pages site",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-github-pages-site"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "switcheroo",
+ "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
+ "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.switcheroo-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "delete-a-github-enterprise-server-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List GitHub Enterprise Server Pages builds",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pages-builds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-github-pages-builds"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "list-github-enterprise-server-pages-builds",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\n \"status\": \"built\",\n \"error\": {\n \"message\": null\n },\n \"pusher\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"commit\": \"351391cdcb88ffae71ec3028c91f375a8036a26b\",\n \"duration\": 2104,\n \"created_at\": \"2014-02-10T19:00:49Z\",\n \"updated_at\": \"2014-02-10T19:00:51Z\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Request a GitHub Enterprise Server Pages build",
+ "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/request-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#request-a-github-pages-build"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "request-a-github-enterprise-server-pages-build",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\n \"status\": \"queued\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds/latest",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get latest Pages build",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-latest-pages-build"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "get-latest-pages-build",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\n \"status\": \"built\",\n \"error\": {\n \"message\": null\n },\n \"pusher\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"commit\": \"351391cdcb88ffae71ec3028c91f375a8036a26b\",\n \"duration\": 2104,\n \"created_at\": \"2014-02-10T19:00:49Z\",\n \"updated_at\": \"2014-02-10T19:00:51Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "build_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/{build_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n build_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/{build_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n build_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get GitHub Enterprise Server Pages build",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-github-pages-build"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "get-github-enterprise-server-pages-build",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\n \"status\": \"built\",\n \"error\": {\n \"message\": null\n },\n \"pusher\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"commit\": \"351391cdcb88ffae71ec3028c91f375a8036a26b\",\n \"duration\": 2104,\n \"created_at\": \"2014-02-10T19:00:49Z\",\n \"updated_at\": \"2014-02-10T19:00:51Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List pre-receive hooks for a repository",
+ "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.",
+ "operationId": "enterprise-admin/list-pre-receive-hooks-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "list-pre-receive-hooks-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a pre-receive hook for a repository",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "get-a-pre-receive-hook-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n enforcement: 'enforcement',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n enforcement: 'enforcement',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update pre-receive hook enforcement for a repository",
+ "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`",
+ "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enforcement": {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "enforcement": "enabled"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "update-pre-receive-hook-enforcement-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
",
+ "bodyParameters": [
+ {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"enabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove pre-receive hook enforcement for a repository",
+ "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.",
+ "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "remove-pre-receive-hook-enforcement-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List repository projects",
+ "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#list-repository-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "list-repository-projects",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n \"url\": \"https://api.github.com/projects/1002604\",\n \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n \"id\": 1002604,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n \"name\": \"Projects Documentation\",\n \"body\": \"Developer documentation project for the developer site.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a repository project",
+ "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#create-a-repository-project"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the project.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the project.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "create-a-repository-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the project.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the project.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n \"url\": \"https://api.github.com/projects/1002604\",\n \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n \"id\": 1002604,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n \"name\": \"Projects Documentation\",\n \"body\": \"Developer documentation project for the developer site.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Either open, closed, or all to filter by state.
"
+ },
+ {
+ "name": "head",
+ "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
"
+ },
+ {
+ "name": "base",
+ "description": "Filter pulls by base branch name. Example: `gh-pages`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Filter pulls by base branch name. Example: gh-pages.
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "popularity",
+ "long-running"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).
"
+ },
+ {
+ "name": "direction",
+ "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#list-pull-requests"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```",
+ "html": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the blog post preview for more details. To access the new draft parameter during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.shadow-cat-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "pulls"
+ },
+ "slug": "list-pull-requests",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world',\n head: 'head',\n base: 'base'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world',\n head: 'head',\n base: 'base'\n})\n
"
+ }
+ ],
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#create-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the new pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the new pull request.",
+ "childParamsGroups": []
+ },
+ "head": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "base": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ "maintainer_can_modify": {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "issue": {
+ "type": "integer",
+ "example": "1",
+ "name": "issue",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "head",
+ "base"
+ ]
+ },
+ "example": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```",
+ "html": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the blog post preview for more details. To access the new draft parameter during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.shadow-cat-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "pulls"
+ },
+ "slug": "create-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the new pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the new pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "1",
+ "name": "issue",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false,\n \"merged\": false,\n \"mergeable\": true,\n \"rebaseable\": true,\n \"mergeable_state\": \"clean\",\n \"merged_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"comments\": 10,\n \"review_comments\": 0,\n \"maintainer_can_modify\": true,\n \"commits\": 3,\n \"additions\": 100,\n \"deletions\": 3,\n \"changed_files\": 5\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be either asc or desc. Ignored without sort parameter.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List review comments in a repository",
+ "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-review-comments-in-a-repository"
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "list-review-comments-in-a-repository",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "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.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-review-comment-for-a-pull-request"
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "get-a-review-comment-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "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.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#update-a-review-comment-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The text of the reply to the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the reply to the review comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "I like this too!"
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.comfort-fade-preview+json
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "update-a-review-comment-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The text of the reply to the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the reply to the review comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a review comment for a pull request",
+ "description": "Deletes a review comment.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/delete-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#delete-a-review-comment-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "delete-a-review-comment-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes a review comment.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a pull request review comment",
+ "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#review-comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-pull-request-review-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-a-pull-request-review-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a pull request review comment.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a pull request review comment",
+ "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-pull-request-review-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the pull request review comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the pull request review comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-a-pull-request-review-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the pull request review comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the pull request review comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a pull request",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.18/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#get-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "get-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server 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\".
\nThe value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server 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.
\nThe value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
\n\n- If merged as a merge commit,
merge_commit_sha represents the SHA of the merge commit. \n- If merged via a squash,
merge_commit_sha represents the SHA of the squashed commit on the base branch. \n- If rebased,
merge_commit_sha represents the commit that the base branch was updated to. \n
\nPass the appropriate media type to fetch diff and patch formats.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false,\n \"merged\": false,\n \"mergeable\": true,\n \"rebaseable\": true,\n \"mergeable_state\": \"clean\",\n \"merged_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"comments\": 10,\n \"review_comments\": 0,\n \"maintainer_can_modify\": true,\n \"commits\": 3,\n \"additions\": 100,\n \"deletions\": 3,\n \"changed_files\": 5\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#update-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the pull request.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "State of this Pull Request. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of this Pull Request. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "maintainer_can_modify": {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```",
+ "html": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the blog post preview for more details. To access the new draft parameter during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.shadow-cat-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "pulls"
+ },
+ "slug": "update-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "State of this Pull Request. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of this Pull Request. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false,\n \"merged\": false,\n \"mergeable\": true,\n \"rebaseable\": true,\n \"mergeable_state\": \"clean\",\n \"merged_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"comments\": 10,\n \"review_comments\": 0,\n \"maintainer_can_modify\": true,\n \"commits\": 3,\n \"additions\": 100,\n \"deletions\": 3,\n \"changed_files\": 5\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be either asc or desc. Ignored without sort parameter.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "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.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-review-comments-on-a-pull-request"
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "list-review-comments-on-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a review comment for a pull request (alternative)",
+ "description": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-an-issue-comment).\"\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "pulls/create-review-comment-alternative",
+ "tags": [
+ "pulls"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#create-a-review-comment-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The text of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the comment.",
+ "childParamsGroups": []
+ },
+ "in_reply_to": {
+ "type": "integer",
+ "description": "The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.
",
+ "name": "in_reply_to",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The comment ID to reply to. **Note**: This must be the ID of a _top-level comment_, not a reply to that comment. Replies to replies are not supported.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Nice change"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "create-a-review-comment-for-a-pull-request-alternative",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"
\nNote: 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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The text of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.
",
+ "name": "in_reply_to",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The comment ID to reply to. **Note**: This must be the ID of a _top-level comment_, not a reply to that comment. Replies to replies are not supported.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a reply for a review comment",
+ "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-reply-for-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#create-a-reply-for-a-review-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the review comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Great stuff!"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "create-a-reply-for-a-review-comment",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the review comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List commits on a pull request",
+ "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits) endpoint.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#list-commits-on-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "list-commits-on-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"support@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"support@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/files', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/files', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List pull requests files",
+ "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-files",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#list-pull-requests-files"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "list-pull-requests-files",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"sha\": \"bbcd538c8e72b8c175046e27cc8f907076331401\",\n \"filename\": \"file1.txt\",\n \"status\": \"added\",\n \"additions\": 103,\n \"deletions\": 21,\n \"changes\": 124,\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"patch\": \"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Check if a pull request has been merged",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/check-if-merged",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#check-if-a-pull-request-has-been-merged"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "check-if-a-pull-request-has-been-merged",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if pull request has been merged"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if pull request has not been merged"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_title: 'commit_title'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_title: 'commit_title'\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#merge-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "commit_title": {
+ "type": "string",
+ "description": "Title for the automatic commit message.
",
+ "name": "commit_title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Title for the automatic commit message.",
+ "childParamsGroups": []
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Extra detail to append to automatic commit message.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Extra detail to append to automatic commit message.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "SHA that pull request head must match to allow merge.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "SHA that pull request head must match to allow merge.",
+ "childParamsGroups": []
+ },
+ "merge_method": {
+ "type": "string",
+ "description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge.
",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ],
+ "name": "merge_method",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "merge-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Title for the automatic commit message.
",
+ "name": "commit_title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Title for the automatic commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Extra detail to append to automatic commit message.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Extra detail to append to automatic commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "SHA that pull request head must match to allow merge.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "SHA that pull request head must match to allow merge.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge.
",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ],
+ "name": "merge_method",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if merge was successful",
+ "payload": "{\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"merged\": true,\n \"message\": \"Pull Request successfully merged\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "405",
+ "httpStatusMessage": "Method Not Allowed",
+ "description": "Response if merge cannot be performed",
+ "payload": "{\n \"message\": \"Pull Request is not mergeable\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Response if sha was provided and pull request head did not match",
+ "payload": "{\n \"message\": \"Head branch was modified. Review and try the merge again.\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List requested reviewers for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-requested-reviewers-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "review-requests"
+ },
+ "slug": "list-requested-reviewers-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "review-requests",
+ "subcategoryLabel": "Review requests",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"users\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/request-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#request-reviewers-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reviewers": {
+ "type": "array of strings",
+ "description": "An array of user logins that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be requested.",
+ "childParamsGroups": []
+ },
+ "team_reviewers": {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be requested.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "review-requests"
+ },
+ "slug": "request-reviewers-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "review-requests",
+ "subcategoryLabel": "Review requests",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "An array of user logins that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be requested.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be requested.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if user is not a collaborator"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Remove requested reviewers from a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/remove-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reviewers": {
+ "type": "array of strings",
+ "description": "An array of user logins that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be removed.",
+ "childParamsGroups": []
+ },
+ "team_reviewers": {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be removed.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "review-requests"
+ },
+ "slug": "remove-requested-reviewers-from-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "review-requests",
+ "subcategoryLabel": "Review requests",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "An array of user logins that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be removed.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be removed.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List reviews for a pull request",
+ "description": "The list of reviews returns in chronological order.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-reviews",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-reviews-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "list-reviews-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The list of reviews returns in chronological order.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"APPROVED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_id: 'commit_id'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_id: 'commit_id'\n})\n
"
+ }
+ ],
+ "summary": "Create a review for a pull request",
+ "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#create-a-review-for-a-pull-request"
+ },
+ "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.
",
+ "name": "commit_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.",
+ "childParamsGroups": []
+ },
+ "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 when you are ready.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
+ "childParamsGroups": []
+ },
+ "comments": {
+ "type": "array of objects",
+ "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": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ "line": {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "side": {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_side": {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "body"
+ ]
+ },
+ "name": "comments",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.",
+ "childParamsGroups": [
+ {
+ "parentName": "comments",
+ "parentType": "items",
+ "id": "comments-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "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."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "create-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
\nNote: 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. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
\nThe position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"This is close to perfect! Please address the suggested inline change.\",\n \"state\": \"CHANGES_REQUESTED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "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.
",
+ "name": "commit_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.",
+ "childParamsGroups": []
+ },
+ {
+ "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 when you are ready.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ "line": {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "side": {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_side": {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "body"
+ ]
+ },
+ "name": "comments",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.",
+ "childParamsGroups": [
+ {
+ "parentName": "comments",
+ "parentType": "items",
+ "id": "comments-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a review for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-review-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "get-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"APPROVED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update a review for a pull request",
+ "description": "Update the review summary comment with new text.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#update-a-review-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "This is close to perfect! Please address the suggested inline change. And add more about this."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "update-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "Update the review summary comment with new text.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"This is close to perfect! Please address the suggested inline change. And add more about this.\",\n \"state\": \"CHANGES_REQUESTED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a pending review for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/delete-pending-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#delete-a-pending-review-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "delete-a-pending-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"This is close to perfect! Please address the suggested inline change.\",\n \"state\": \"CHANGES_REQUESTED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List comments for a pull request review",
+ "description": "List comments for a specific pull request review.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-comments-for-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-comments-for-a-pull-request-review"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "list-comments-for-a-pull-request-review",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List comments for a specific pull request review.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n message: 'message'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n message: 'message'\n})\n
"
+ }
+ ],
+ "summary": "Dismiss a review for a pull request",
+ "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/dismiss-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#dismiss-a-review-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The message for the pull request review dismissal
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The message for the pull request review dismissal",
+ "childParamsGroups": []
+ },
+ "event": {
+ "type": "string",
+ "example": "\"APPROVE\"",
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "message"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "dismiss-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The message for the pull request review dismissal
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The message for the pull request review dismissal",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"APPROVE\"",
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"DISMISSED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n event: 'event'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n event: 'event'\n})\n
"
+ }
+ ],
+ "summary": "Submit a review for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/submit-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#submit-a-review-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The body text of the pull request review
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review",
+ "childParamsGroups": []
+ },
+ "event": {
+ "type": "string",
+ "description": "Required. The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "event"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "submit-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The body text of the pull request review
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"APPROVED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n expected_head_sha: 'expected_head_sha',\n mediaType: {\n previews: [\n 'lydian'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n expected_head_sha: 'expected_head_sha',\n mediaType: {\n previews: [\n 'lydian'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a pull request branch",
+ "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#update-a-pull-request-branch"
+ },
+ "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\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
",
+ "name": "expected_head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "lydian",
+ "note": "Updating the pull request branch with latest upstream changes is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.lydian-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.lydian-preview+json
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "update-a-pull-request-branch",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
",
+ "bodyParameters": [
+ {
+ "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\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
",
+ "name": "expected_head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response",
+ "payload": "{\n \"message\": \"Updating pull request branch.\",\n \"url\": \"https://github.com/repos/octocat/Hello-World/pulls/53\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/readme",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/readme', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/readme', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a repository README",
+ "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-readme",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "get-a-repository-readme",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"file\",\n \"encoding\": \"base64\",\n \"size\": 5362,\n \"name\": \"README.md\",\n \"path\": \"README.md\",\n \"content\": \"encoded content ...\",\n \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List releases",
+ "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-releases",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-releases"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "list-releases",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/releases",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_name: 'tag_name'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_name: 'tag_name'\n})\n
"
+ }
+ ],
+ "summary": "Create a release",
+ "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-release"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "Required. The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "true to create a draft (unpublished) release, false to create a published one.
",
+ "default": false,
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.",
+ "childParamsGroups": []
+ },
+ "prerelease": {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease. false to identify the release as a full release.
",
+ "default": false,
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "create-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to create a draft (unpublished) release, false to create a published one.
",
+ "default": false,
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease. false to identify the release as a full release.
",
+ "default": false,
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "asset_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a release asset",
+ "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-release-asset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Found"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "asset_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42,\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42,\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update a release asset",
+ "description": "Users with push access to the repository can edit a release asset.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-release-asset"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The file name of the asset.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file name of the asset.",
+ "childParamsGroups": []
+ },
+ "label": {
+ "type": "string",
+ "description": "An alternate short description of the asset. Used in place of the filename.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An alternate short description of the asset. Used in place of the filename.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "example": "\"uploaded\"",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "update-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "descriptionHTML": "Users with push access to the repository can edit a release asset.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The file name of the asset.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file name of the asset.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "An alternate short description of the asset. Used in place of the filename.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An alternate short description of the asset. Used in place of the filename.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"uploaded\"",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "asset_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a release asset",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-release-asset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "delete-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/latest",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the latest release",
+ "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-latest-release"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-the-latest-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "tag",
+ "description": "tag+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "tag+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/tags/{tag}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/tags/{tag}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag'\n})\n
"
+ }
+ ],
+ "summary": "Get a release by tag name",
+ "description": "Get a published release with the specified tag.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-by-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-release-by-tag-name"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-a-release-by-tag-name",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a published release with the specified tag.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a release",
+ "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#hypermedia).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-release"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n tag_name: 'tag_name'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n tag_name: 'tag_name'\n})\n
"
+ }
+ ],
+ "summary": "Update a release",
+ "description": "Users with push access to the repository can edit a release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-release"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "true makes the release a draft, and false publishes the release.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` makes the release a draft, and `false` publishes the release.",
+ "childParamsGroups": []
+ },
+ "prerelease": {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease, false to identify the release as a full release.
",
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "update-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "descriptionHTML": "Users with push access to the repository can edit a release.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true makes the release a draft, and false publishes the release.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` makes the release a draft, and `false` publishes the release.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease, false to identify the release as a full release.
",
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a release",
+ "description": "Users with push access to the repository can delete a release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-release"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "delete-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with push access to the repository can delete a release.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List release assets",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-release-assets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-release-assets"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "list-release-assets",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "label",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Upload a release asset",
+ "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server 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://docs.github.com/enterprise-server@2.18/rest/reference/repos#upload-a-release-asset"
+ },
+ "servers": [
+ {
+ "url": "{origin}",
+ "variables": {
+ "origin": {
+ "default": "https://uploads.github.com",
+ "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint"
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "string",
+ "description": "The raw file data"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "upload-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint makes use of a Hypermedia relation 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 to upload a release asset.
\nYou need to use an HTTP client which supports SNI to make calls to this endpoint.
\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. For example:
\napplication/zip
\nGitHub Enterprise Server 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.
\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.
\nNotes:
\n\n- GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List assets for a release\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Server Support.
\n- If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
\n
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response for successful upload",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stargazers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stargazers', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stargazers', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List stargazers",
+ "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-stargazers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-stargazers"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "list-stargazers",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/code_frequency",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/code_frequency', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/code_frequency', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the weekly commit activity",
+ "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-code-frequency-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-weekly-commit-activity"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-weekly-commit-activity",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n [\n 1302998400,\n 1124,\n -435\n ]\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/commit_activity",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/commit_activity', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/commit_activity', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the last year of commit activity",
+ "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-activity-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-last-year-of-commit-activity"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-last-year-of-commit-activity",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"days\": [\n 0,\n 3,\n 26,\n 20,\n 39,\n 1,\n 0\n ],\n \"total\": 89,\n \"week\": 1336280400\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/contributors",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get all contributor commit activity",
+ "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-contributors-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-all-contributor-commit-activity"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-all-contributor-commit-activity",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
\n\nw - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commits
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"total\": 135,\n \"weeks\": [\n {\n \"w\": \"1367712000\",\n \"a\": 6898,\n \"d\": 77,\n \"c\": 10\n }\n ]\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/participation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/participation', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/participation', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the weekly commit count",
+ "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-participation-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-weekly-commit-count"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-weekly-commit-count",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThe array order is oldest week (index 0) to most recent week.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"all\": [\n 11,\n 21,\n 15,\n 2,\n 8,\n 1,\n 8,\n 23,\n 17,\n 21,\n 11,\n 10,\n 33,\n 91,\n 38,\n 34,\n 22,\n 23,\n 32,\n 3,\n 43,\n 87,\n 71,\n 18,\n 13,\n 5,\n 13,\n 16,\n 66,\n 27,\n 12,\n 45,\n 110,\n 117,\n 13,\n 8,\n 18,\n 9,\n 19,\n 26,\n 39,\n 12,\n 20,\n 31,\n 46,\n 91,\n 45,\n 10,\n 24,\n 9,\n 29,\n 7\n ],\n \"owner\": [\n 3,\n 2,\n 3,\n 0,\n 2,\n 0,\n 5,\n 14,\n 7,\n 9,\n 1,\n 5,\n 0,\n 48,\n 19,\n 2,\n 0,\n 1,\n 10,\n 2,\n 23,\n 40,\n 35,\n 8,\n 8,\n 2,\n 10,\n 6,\n 30,\n 0,\n 2,\n 9,\n 53,\n 104,\n 3,\n 3,\n 10,\n 4,\n 7,\n 11,\n 21,\n 4,\n 4,\n 22,\n 26,\n 63,\n 11,\n 2,\n 14,\n 1,\n 10,\n 3\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/punch_card",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/punch_card', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/punch_card', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the hourly commit count for each day",
+ "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-punch-card-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-hourly-commit-count-for-each-day"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-hourly-commit-count-for-each-day",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n\n0-6: Sunday - Saturday0-23: Hour of day- Number of commits
\n
\nFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n [\n 0,\n 0,\n 5\n ],\n [\n 0,\n 1,\n 43\n ],\n [\n 0,\n 2,\n 21\n ]\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/statuses/{sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n sha: 'sha',\n state: 'state'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/statuses/{sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n sha: 'sha',\n state: 'state'\n})\n
"
+ }
+ ],
+ "summary": "Create a commit status",
+ "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-commit-status"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "Required. The state of the status. Can be one of error, failure, pending, or success.
",
+ "enum": [
+ "error",
+ "failure",
+ "pending",
+ "success"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.",
+ "childParamsGroups": []
+ },
+ "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:
\nhttp://ci.example.com/user/repo/build/sha
",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the status.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status.",
+ "childParamsGroups": []
+ },
+ "context": {
+ "type": "string",
+ "description": "A string label to differentiate this status from the status of other systems.
",
+ "default": "default",
+ "name": "context",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A string label to differentiate this status from the status of other systems.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statuses"
+ },
+ "slug": "create-a-commit-status",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statuses",
+ "subcategoryLabel": "Statuses",
+ "notes": [],
+ "descriptionHTML": "Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The state of the status. Can be one of error, failure, pending, or success.
",
+ "enum": [
+ "error",
+ "failure",
+ "pending",
+ "success"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.",
+ "childParamsGroups": []
+ },
+ {
+ "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:
\nhttp://ci.example.com/user/repo/build/sha
",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the status.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A string label to differentiate this status from the status of other systems.
",
+ "default": "default",
+ "name": "context",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A string label to differentiate this status from the status of other systems.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"id\": 1,\n \"node_id\": \"MDY6U3RhdHVzMQ==\",\n \"state\": \"success\",\n \"description\": \"Build has completed successfully\",\n \"target_url\": \"https://ci.example.com/1000/output\",\n \"context\": \"continuous-integration/jenkins\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/subscribers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/subscribers', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/subscribers', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List watchers",
+ "description": "Lists the people watching the specified repository.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-watchers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-watchers"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "list-watchers",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people watching the specified repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a repository subscription",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#get-a-repository-subscription"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "get-a-repository-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if you subscribe to the repository",
+ "payload": "{\n \"subscribed\": true,\n \"ignored\": false,\n \"reason\": null,\n \"created_at\": \"2012-10-06T21:34:12Z\",\n \"url\": \"https://api.github.com/repos/octocat/example/subscription\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if you don t subscribe to the repository"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world',\n subscribed: true\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world',\n subscribed: true\n})\n
"
+ }
+ ],
+ "summary": "Set a repository subscription",
+ "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@2.18/rest/reference/activity#delete-a-repository-subscription) completely.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#set-a-repository-subscription"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "subscribed": {
+ "type": "boolean",
+ "description": "Determines if notifications should be received from this repository.
",
+ "name": "subscribed",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications should be received from this repository.",
+ "childParamsGroups": []
+ },
+ "ignored": {
+ "type": "boolean",
+ "description": "Determines if all notifications should be blocked from this repository.
",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if all notifications should be blocked from this repository.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "set-a-repository-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "descriptionHTML": "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 completely.
",
+ "bodyParameters": [
+ {
+ "type": "boolean",
+ "description": "Determines if notifications should be received from this repository.
",
+ "name": "subscribed",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications should be received from this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if all notifications should be blocked from this repository.
",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if all notifications should be blocked from this repository.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"subscribed\": true,\n \"ignored\": false,\n \"reason\": null,\n \"created_at\": \"2012-10-06T21:34:12Z\",\n \"url\": \"https://api.github.com/repos/octocat/example/subscription\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository subscription",
+ "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@2.18/rest/reference/activity#set-a-repository-subscription).",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#delete-a-repository-subscription"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "delete-a-repository-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/tags",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/tags', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/tags', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository tags",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-tags",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-tags"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-tags",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"name\": \"v0.1\",\n \"commit\": {\n \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n },\n \"zipball_url\": \"https://github.com/octocat/Hello-World/zipball/v0.1\",\n \"tarball_url\": \"https://github.com/octocat/Hello-World/tarball/v0.1\",\n \"node_id\": \"MDQ6VXNlcjE=\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/tarball/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/tarball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/tarball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Download a repository archive (tar)",
+ "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#download-a-repository-archive"
+ },
+ "operationId": "repos/download-tarball-archive",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "download-a-repository-archive-tar",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/teams', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/teams', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository teams",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-teams"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-teams",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/topics",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#get-all-repository-topics"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "get-all-repository-topics",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"names\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/topics",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ],\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ],\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Replace all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/replace-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#replace-all-repository-topics"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "names"
+ ]
+ },
+ "example": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "replace-all-repository-topics",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"names\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/transfer",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/transfer', {\n owner: 'octocat',\n repo: 'hello-world',\n new_owner: 'new_owner'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/transfer', {\n owner: 'octocat',\n repo: 'hello-world',\n new_owner: 'new_owner'\n})\n
"
+ }
+ ],
+ "summary": "Transfer a repository",
+ "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/transfer",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#transfer-a-repository"
+ },
+ "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.
",
+ "name": "new_owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required:** The username or organization name the repository will be transferred to.",
+ "childParamsGroups": []
+ },
+ "team_ids": {
+ "type": "array of integers",
+ "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
",
+ "items": {
+ "type": "integer"
+ },
+ "name": "team_ids",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "transfer-a-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required: The username or organization name the repository will be transferred to.
",
+ "name": "new_owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required:** The username or organization name the repository will be transferred to.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of integers",
+ "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
",
+ "items": {
+ "type": "integer"
+ },
+ "name": "team_ids",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Enable vulnerability alerts",
+ "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/enable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#enable-vulnerability-alerts"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "dorian",
+ "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.dorian-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "enable-vulnerability-alerts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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\".
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Disable vulnerability alerts",
+ "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#disable-vulnerability-alerts"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "dorian",
+ "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.dorian-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "disable-vulnerability-alerts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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\".
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/zipball/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/zipball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/zipball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Download a repository archive (zip)",
+ "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#download-a-repository-archive"
+ },
+ "operationId": "repos/download-zipball-archive",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "download-a-repository-archive-zip",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{template_owner}/{template_repo}/generate",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "template_owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "template_repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{template_owner}/{template_repo}/generate', {\n template_owner: 'template_owner',\n template_repo: 'template_repo',\n name: 'name',\n mediaType: {\n previews: [\n 'baptiste'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{template_owner}/{template_repo}/generate', {\n template_owner: 'template_owner',\n template_repo: 'template_repo',\n name: 'name',\n mediaType: {\n previews: [\n 'baptiste'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a repository using a template",
+ "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-using-template",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#create-a-repository-using-a-template"
+ },
+ "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": "owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the new repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the new repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the new repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the new repository.",
+ "childParamsGroups": []
+ },
+ "include_all_branches": {
+ "type": "boolean",
+ "description": "Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.
",
+ "default": false,
+ "name": "include_all_branches",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either true to create a new private repository or false to create a new public one.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "baptiste",
+ "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "create-a-repository-using-a-template",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "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 endpoint and check that the is_template key is true.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repository
",
+ "bodyParameters": [
+ {
+ "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": "owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The name of the new repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the new repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the new repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the new repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.
",
+ "default": false,
+ "name": "include_all_branches",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to create a new private repository or false to create a new public one.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"forks\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"open_issues\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://github.com/licenses/mit\"\n },\n \"anonymous_access_enabled\": false,\n \"template_repository\": {\n \"anonymous_access_enabled\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "since",
+ "description": "A repository ID. Only return repositories with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "A repository ID. Only return repositories with an ID greater than this ID.
"
+ },
+ {
+ "name": "visibility",
+ "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "public",
+ "example": "all",
+ "enum": [
+ "all",
+ "public"
+ ]
+ },
+ "descriptionHTML": "Specifies the types of repositories to return. Can be one of all or public. Default: public.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repositories')",
+ "html": "await octokit.request('GET /repositories')\n
"
+ }
+ ],
+ "summary": "List public repositories",
+ "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-public-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-public-repositories",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/code",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching code\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "indexed"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/code', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/code', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search code",
+ "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-code"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-code",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
\nq=addClass+in:file+language:js+repo:jquery/jquery
\nThis query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:
\n\n- Only the default branch is considered. In most cases, this will be the
master branch. \n- Only files smaller than 384 KB are searchable.
\n- You must always include at least one search term when searching source code. For example, searching for
language:go is not valid, while amazing language:go is. \n
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 7,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"name\": \"classes.js\",\n \"path\": \"src/attributes/classes.js\",\n \"sha\": \"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\n \"url\": \"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\n \"git_url\": \"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\n \"html_url\": \"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\n \"repository\": {\n \"id\": 167174,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\n \"name\": \"jquery\",\n \"full_name\": \"jquery/jquery\",\n \"owner\": {\n \"login\": \"jquery\",\n \"id\": 70142,\n \"node_id\": \"MDQ6VXNlcjcwMTQy\",\n \"avatar_url\": \"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/jquery\",\n \"html_url\": \"https://github.com/jquery\",\n \"followers_url\": \"https://api.github.com/users/jquery/followers\",\n \"following_url\": \"https://api.github.com/users/jquery/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/jquery/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/jquery/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/jquery/orgs\",\n \"repos_url\": \"https://api.github.com/users/jquery/repos\",\n \"events_url\": \"https://api.github.com/users/jquery/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/jquery/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/jquery/jquery\",\n \"description\": \"jQuery JavaScript Library\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/jquery/jquery\",\n \"forks_url\": \"https://api.github.com/repos/jquery/jquery/forks\",\n \"keys_url\": \"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\n \"collaborators_url\": \"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\n \"teams_url\": \"https://api.github.com/repos/jquery/jquery/teams\",\n \"hooks_url\": \"https://api.github.com/repos/jquery/jquery/hooks\",\n \"issue_events_url\": \"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\n \"events_url\": \"https://api.github.com/repos/jquery/jquery/events\",\n \"assignees_url\": \"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\n \"branches_url\": \"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\n \"tags_url\": \"https://api.github.com/repos/jquery/jquery/tags\",\n \"blobs_url\": \"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\n \"trees_url\": \"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\n \"statuses_url\": \"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\n \"languages_url\": \"https://api.github.com/repos/jquery/jquery/languages\",\n \"stargazers_url\": \"https://api.github.com/repos/jquery/jquery/stargazers\",\n \"contributors_url\": \"https://api.github.com/repos/jquery/jquery/contributors\",\n \"subscribers_url\": \"https://api.github.com/repos/jquery/jquery/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/jquery/jquery/subscription\",\n \"commits_url\": \"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\n \"git_commits_url\": \"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\n \"comments_url\": \"https://api.github.com/repos/jquery/jquery/comments{/number}\",\n \"issue_comment_url\": \"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\n \"contents_url\": \"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\n \"compare_url\": \"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\n \"merges_url\": \"https://api.github.com/repos/jquery/jquery/merges\",\n \"archive_url\": \"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\n \"downloads_url\": \"https://api.github.com/repos/jquery/jquery/downloads\",\n \"issues_url\": \"https://api.github.com/repos/jquery/jquery/issues{/number}\",\n \"pulls_url\": \"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\n \"milestones_url\": \"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\n \"labels_url\": \"https://api.github.com/repos/jquery/jquery/labels{/name}\",\n \"deployments_url\": \"http://api.github.com/repos/octocat/Hello-World/deployments\",\n \"releases_url\": \"http://api.github.com/repos/octocat/Hello-World/releases{/id}\"\n },\n \"score\": 1\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching commits\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "author-date",
+ "committer-date"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query by author-date or committer-date. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/commits', {\n q: 'q',\n mediaType: {\n previews: [\n 'cloak'\n ]\n }\n})",
+ "html": "await octokit.request('GET /search/commits', {\n q: 'q',\n mediaType: {\n previews: [\n 'cloak'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Search commits",
+ "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-commits"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "cloak",
+ "note": "The Commit Search API is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2017-01-05-commit-search-api/) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.cloak-preview
"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-commits",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
\nWhen searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
\nFor example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"sha\": \"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"html_url\": \"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"author\": {\n \"date\": \"2014-02-04T14:38:36-08:00\",\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"date\": \"2014-02-12T15:18:55-08:00\",\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"message\": \"Create styles.css and updated README\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\n \"sha\": \"a639e96f9038797fba6e0469f94a4b0cc459fa68\"\n },\n \"comment_count\": 8\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 583231,\n \"node_id\": \"MDQ6VXNlcjU4MzIzMQ==\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/583231?v=3\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {},\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\n \"html_url\": \"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\n \"sha\": \"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"\n }\n ],\n \"repository\": {\n \"id\": 1300192,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\n \"name\": \"Spoon-Knife\",\n \"full_name\": \"octocat/Spoon-Knife\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 583231,\n \"node_id\": \"MDQ6VXNlcjU4MzIzMQ==\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/583231?v=3\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Spoon-Knife\",\n \"description\": \"This repo is for demonstration purposes only.\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\n \"events_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/events\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"\n },\n \"score\": 1,\n \"node_id\": \"MDQ6VXNlcjU4MzIzMQ==\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching issues and pull requests\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "comments",
+ "reactions",
+ "reactions-+1",
+ "reactions--1",
+ "reactions-smile",
+ "reactions-thinking_face",
+ "reactions-heart",
+ "reactions-tada",
+ "interactions",
+ "created",
+ "updated"
+ ]
+ },
+ "descriptionHTML": "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
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/issues', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/issues', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search issues and pull requests",
+ "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/issues-and-pull-requests",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-issues-and-pull-requests"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-issues-and-pull-requests",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
\nThis query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
\nNote: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 280,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\n \"repository_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\n \"labels_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\n \"events_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\n \"html_url\": \"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\n \"id\": 35802,\n \"node_id\": \"MDU6SXNzdWUzNTgwMg==\",\n \"number\": 132,\n \"title\": \"Line Number Indexes Beyond 20 Not Displayed\",\n \"user\": {\n \"login\": \"Nick3C\",\n \"id\": 90254,\n \"node_id\": \"MDQ6VXNlcjkwMjU0\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/Nick3C\",\n \"html_url\": \"https://github.com/Nick3C\",\n \"followers_url\": \"https://api.github.com/users/Nick3C/followers\",\n \"following_url\": \"https://api.github.com/users/Nick3C/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/Nick3C/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/Nick3C/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/Nick3C/orgs\",\n \"repos_url\": \"https://api.github.com/users/Nick3C/repos\",\n \"events_url\": \"https://api.github.com/users/Nick3C/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/Nick3C/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"labels\": [\n {\n \"id\": 4,\n \"node_id\": \"MDU6TGFiZWw0\",\n \"url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\n \"name\": \"bug\",\n \"color\": \"ff0000\"\n }\n ],\n \"state\": \"open\",\n \"assignee\": null,\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"comments\": 15,\n \"created_at\": \"2009-07-12T20:10:41Z\",\n \"updated_at\": \"2009-07-19T09:23:43Z\",\n \"closed_at\": null,\n \"pull_request\": {\n \"url\": \"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"body\": \"...\",\n \"score\": 1,\n \"locked\": true,\n \"author_association\": \"collaborator\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "repository_id",
+ "description": "The id of the repository.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "The id of the repository.
"
+ },
+ {
+ "name": "q",
+ "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query by when the label was created or updated. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "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.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/labels', {\n repository_id: 42,\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/labels', {\n repository_id: 42,\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search labels",
+ "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-labels"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-labels",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
\nq=bug+defect+enhancement&repository_id=64778136
\nThe labels that best match the query appear first in the search results.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 2,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"id\": 418327088,\n \"node_id\": \"MDU6TGFiZWw0MTgzMjcwODg=\",\n \"url\": \"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\n \"name\": \"enhancement\",\n \"color\": \"84b6eb\",\n \"default\": true,\n \"description\": \"New feature or request.\",\n \"score\": 1\n },\n {\n \"id\": 418327086,\n \"node_id\": \"MDU6TGFiZWw0MTgzMjcwODY=\",\n \"url\": \"https://api.github.com/repos/octocat/linguist/labels/bug\",\n \"name\": \"bug\",\n \"color\": \"ee0701\",\n \"default\": true,\n \"description\": \"Something isn't working.\",\n \"score\": 1\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching for repositories\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "stars",
+ "forks",
+ "help-wanted-issues",
+ "updated"
+ ]
+ },
+ "descriptionHTML": "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
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/repositories', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/repositories', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search repositories",
+ "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-repositories",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
\nThis query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
\nWhen you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
\nq=topic:ruby+topic:rails
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 40,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"id\": 3081286,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\n \"name\": \"Tetris\",\n \"full_name\": \"dtrupenn/Tetris\",\n \"owner\": {\n \"login\": \"dtrupenn\",\n \"id\": 872147,\n \"node_id\": \"MDQ6VXNlcjg3MjE0Nw==\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/dtrupenn\",\n \"received_events_url\": \"https://api.github.com/users/dtrupenn/received_events\",\n \"type\": \"User\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"site_admin\": true\n },\n \"private\": false,\n \"html_url\": \"https://github.com/dtrupenn/Tetris\",\n \"description\": \"A C implementation of Tetris using Pennsim through LC4\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/dtrupenn/Tetris\",\n \"created_at\": \"2012-01-01T00:31:50Z\",\n \"updated_at\": \"2013-01-05T17:58:47Z\",\n \"pushed_at\": \"2012-01-01T00:37:02Z\",\n \"homepage\": \"https://github.com\",\n \"size\": 524,\n \"stargazers_count\": 1,\n \"watchers_count\": 1,\n \"language\": \"Assembly\",\n \"forks_count\": 0,\n \"open_issues_count\": 0,\n \"master_branch\": \"master\",\n \"default_branch\": \"master\",\n \"score\": 1,\n \"archive_url\": \"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\n \"events_url\": \"https://api.github.com/repos/dtrupenn/Tetris/events\",\n \"forks_url\": \"https://api.github.com/repos/dtrupenn/Tetris/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\n \"git_url\": \"git:github.com/dtrupenn/Tetris.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/dtrupenn/Tetris/languages\",\n \"merges_url\": \"https://api.github.com/repos/dtrupenn/Tetris/merges\",\n \"milestones_url\": \"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\n \"ssh_url\": \"git@github.com:dtrupenn/Tetris.git\",\n \"stargazers_url\": \"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\n \"tags_url\": \"https://api.github.com/repos/dtrupenn/Tetris/tags\",\n \"teams_url\": \"https://api.github.com/repos/dtrupenn/Tetris/teams\",\n \"trees_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/dtrupenn/Tetris.git\",\n \"mirror_url\": \"git:git.example.com/dtrupenn/Tetris\",\n \"hooks_url\": \"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\n \"svn_url\": \"https://svn.github.com/dtrupenn/Tetris\",\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_pages\": true,\n \"has_wiki\": true,\n \"has_downloads\": true,\n \"archived\": true,\n \"disabled\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/topics",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/topics', {\n q: 'q',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})",
+ "html": "await octokit.request('GET /search/topics', {\n q: 'q',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Search topics",
+ "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-topics"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-topics",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
\nThis query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 6,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"name\": \"ruby\",\n \"display_name\": \"Ruby\",\n \"short_description\": \"Ruby is a scripting language designed for simplified object-oriented programming.\",\n \"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.\",\n \"created_by\": \"Yukihiro Matsumoto\",\n \"released\": \"December 21, 1995\",\n \"created_at\": \"2016-11-28T22:03:59Z\",\n \"updated_at\": \"2017-10-30T18:16:32Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"rails\",\n \"display_name\": \"Rails\",\n \"short_description\": \"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\n \"description\": \"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\n \"created_by\": \"David Heinemeier Hansson\",\n \"released\": \"December 13 2005\",\n \"created_at\": \"2016-12-09T17:03:50Z\",\n \"updated_at\": \"2017-10-30T16:20:19Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"python\",\n \"display_name\": \"Python\",\n \"short_description\": \"Python is a dynamically typed programming language.\",\n \"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.\",\n \"created_by\": \"Guido van Rossum\",\n \"released\": \"February 20, 1991\",\n \"created_at\": \"2016-12-07T00:07:02Z\",\n \"updated_at\": \"2017-10-27T22:45:43Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"jekyll\",\n \"display_name\": \"Jekyll\",\n \"short_description\": \"Jekyll is a simple, blog-aware static site generator.\",\n \"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.\",\n \"created_by\": \"Tom Preston-Werner\",\n \"released\": \"2008\",\n \"created_at\": \"2016-12-16T21:53:08Z\",\n \"updated_at\": \"2017-10-27T19:00:24Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"sass\",\n \"display_name\": \"Sass\",\n \"short_description\": \"Sass is a stable extension to classic CSS.\",\n \"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.\",\n \"created_by\": \"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\n \"released\": \"November 28, 2006\",\n \"created_at\": \"2016-12-16T21:53:45Z\",\n \"updated_at\": \"2018-01-16T16:30:40Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"homebrew\",\n \"display_name\": \"Homebrew\",\n \"short_description\": \"Homebrew is a package manager for macOS.\",\n \"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.\",\n \"created_by\": \"Max Howell\",\n \"released\": \"2009\",\n \"created_at\": \"2016-12-17T20:30:44Z\",\n \"updated_at\": \"2018-02-06T16:14:56Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching users\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "followers",
+ "repositories",
+ "joined"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/users', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/users', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search users",
+ "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-users"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-users",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
\nThis query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 12,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"login\": \"mojombo\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/mojombo\",\n \"html_url\": \"https://github.com/mojombo\",\n \"followers_url\": \"https://api.github.com/users/mojombo/followers\",\n \"subscriptions_url\": \"https://api.github.com/users/mojombo/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/mojombo/orgs\",\n \"repos_url\": \"https://api.github.com/users/mojombo/repos\",\n \"received_events_url\": \"https://api.github.com/users/mojombo/received_events\",\n \"type\": \"User\",\n \"score\": 1,\n \"following_url\": \"https://api.github.com/users/mojombo/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/mojombo/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\n \"events_url\": \"https://api.github.com/users/mojombo/events{/privacy}\",\n \"site_admin\": true\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/configcheck",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/configcheck')",
+ "html": "await octokit.request('GET /setup/api/configcheck')\n
"
+ }
+ ],
+ "summary": "Get the configuration status",
+ "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |",
+ "operationId": "enterprise-admin/get-configuration-status",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-the-configuration-status"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-the-configuration-status",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint allows you to check the status of the most recent configuration process:
\nNote that you may need to wait several seconds after you start a process before you can check its status.
\nThe different statuses are:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Status | Description |
|---|
PENDING | The job has not started yet |
CONFIGURING | The job is running |
DONE | The job has finished correctly |
FAILED | The job has finished unexpectedly |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"status\": \"running\",\n \"progress\": [\n {\n \"status\": \"DONE\",\n \"key\": \"Appliance core components\"\n },\n {\n \"status\": \"DONE\",\n \"key\": \"GitHub utilities\"\n },\n {\n \"status\": \"DONE\",\n \"key\": \"GitHub applications\"\n },\n {\n \"status\": \"CONFIGURING\",\n \"key\": \"GitHub services\"\n },\n {\n \"status\": \"PENDING\",\n \"key\": \"Reloading appliance services\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/configure",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/configure')",
+ "html": "await octokit.request('POST /setup/api/configure')\n
"
+ }
+ ],
+ "summary": "Start a configuration process",
+ "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:",
+ "operationId": "enterprise-admin/start-configuration-process",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#start-a-configuration-process"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "start-a-configuration-process",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/maintenance",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/maintenance')",
+ "html": "await octokit.request('GET /setup/api/maintenance')\n
"
+ }
+ ],
+ "summary": "Get the maintenance status",
+ "description": "Check your installation's maintenance status:",
+ "operationId": "enterprise-admin/get-maintenance-status",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-the-maintenance-status"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-the-maintenance-status",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Check your installation's maintenance status:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15 => 34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/maintenance",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/maintenance', {\n maintenance: 'maintenance'\n})",
+ "html": "await octokit.request('POST /setup/api/maintenance', {\n maintenance: 'maintenance'\n})\n
"
+ }
+ ],
+ "summary": "Enable or disable maintenance mode",
+ "description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).",
+ "operationId": "enterprise-admin/enable-or-disable-maintenance-mode",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "maintenance": {
+ "type": "string",
+ "description": "Required. A JSON string with the attributes enabled and when.
",
+ "name": "maintenance",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the attributes `enabled` and `when`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "maintenance"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "enable-or-disable-maintenance-mode",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "descriptionHTML": "The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.
\nThe possible values for when are now or any date parseable by mojombo/chronic.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. A JSON string with the attributes enabled and when.
",
+ "name": "maintenance",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the attributes `enabled` and `when`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15 => 34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/settings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/settings')",
+ "html": "await octokit.request('GET /setup/api/settings')\n
"
+ }
+ ],
+ "summary": "Get settings",
+ "description": "",
+ "operationId": "enterprise-admin/get-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-settings"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-settings",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"enterprise\": {\n \"private_mode\": false,\n \"public_pages\": false,\n \"subdomain_isolation\": true,\n \"signup_enabled\": false,\n \"github_hostname\": \"ghe.local\",\n \"identicons_host\": \"dotcom\",\n \"http_proxy\": null,\n \"auth_mode\": \"default\",\n \"expire_sessions\": false,\n \"admin_password\": null,\n \"configuration_id\": 1401777404,\n \"configuration_run_count\": 4,\n \"avatar\": {\n \"enabled\": false,\n \"uri\": \"\"\n },\n \"customer\": {\n \"name\": \"GitHub\",\n \"email\": \"stannis@themannis.biz\",\n \"uuid\": \"af6cac80-e4e1-012e-d822-1231380e52e9\",\n \"secret_key_data\": \"-----BEGIN PGP PRIVATE KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\\n-----END PGP PRIVATE KEY BLOCK-----\\n\",\n \"public_key_data\": \"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"\n },\n \"license\": {\n \"seats\": 0,\n \"evaluation\": false,\n \"perpetual\": false,\n \"unlimited_seating\": true,\n \"support_key\": \"ssh-rsa AAAAB3N....\",\n \"ssh_allowed\": true,\n \"cluster_support\": false,\n \"expire_at\": \"2016-04-27T00:00:00-07:00\"\n },\n \"github_ssl\": {\n \"enabled\": false,\n \"cert\": null,\n \"key\": null\n },\n \"ldap\": {\n \"host\": null,\n \"port\": 0,\n \"base\": [],\n \"uid\": null,\n \"bind_dn\": null,\n \"password\": null,\n \"method\": \"Plain\",\n \"search_strategy\": \"detect\",\n \"user_groups\": [],\n \"admin_group\": null,\n \"virtual_attribute_enabled\": false,\n \"recursive_group_search\": false,\n \"posix_support\": true,\n \"user_sync_emails\": false,\n \"user_sync_keys\": false,\n \"user_sync_interval\": 4,\n \"team_sync_interval\": 4,\n \"sync_enabled\": false,\n \"reconciliation\": {\n \"user\": null,\n \"org\": null\n },\n \"profile\": {\n \"uid\": \"uid\",\n \"name\": null,\n \"mail\": null,\n \"key\": null\n }\n },\n \"cas\": {\n \"url\": null\n },\n \"saml\": {\n \"sso_url\": null,\n \"certificate\": null,\n \"certificate_path\": null,\n \"issuer\": null,\n \"idp_initiated_sso\": false,\n \"disable_admin_demote\": false\n },\n \"github_oauth\": {\n \"client_id\": \"12313412\",\n \"client_secret\": \"kj123131132\",\n \"organization_name\": \"Homestar Runners\",\n \"organization_team\": \"homestarrunners/characters\"\n },\n \"smtp\": {\n \"enabled\": true,\n \"address\": \"smtp.example.com\",\n \"authentication\": \"plain\",\n \"port\": \"1234\",\n \"domain\": \"blah\",\n \"username\": \"foo\",\n \"user_name\": \"mr_foo\",\n \"enable_starttls_auto\": true,\n \"password\": \"bar\",\n \"discard-to-noreply-address\": true,\n \"support_address\": \"enterprise@github.com\",\n \"support_address_type\": \"email\",\n \"noreply_address\": \"noreply@github.com\"\n },\n \"ntp\": {\n \"primary_server\": \"0.pool.ntp.org\",\n \"secondary_server\": \"1.pool.ntp.org\"\n },\n \"timezone\": null,\n \"snmp\": {\n \"enabled\": false,\n \"community\": \"\"\n },\n \"syslog\": {\n \"enabled\": false,\n \"server\": null,\n \"protocol_name\": \"udp\"\n },\n \"assets\": null,\n \"pages\": {\n \"enabled\": true\n },\n \"collectd\": {\n \"enabled\": false,\n \"server\": null,\n \"port\": 0,\n \"encryption\": null,\n \"username\": null,\n \"password\": null\n },\n \"mapping\": {\n \"enabled\": true,\n \"tileserver\": null,\n \"basemap\": \"company.map-qsz2zrvs\",\n \"token\": null\n },\n \"load_balancer\": null\n },\n \"run_list\": [\n \"recipe[enterprise-configure]\"\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/setup/api/settings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /setup/api/settings', {\n settings: 'settings'\n})",
+ "html": "await octokit.request('PUT /setup/api/settings', {\n settings: 'settings'\n})\n
"
+ }
+ ],
+ "summary": "Set settings",
+ "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-settings).",
+ "operationId": "enterprise-admin/set-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#set-settings"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "settings": {
+ "type": "string",
+ "description": "Required. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "settings"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "set-settings",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "For a list of the available settings, see the Get settings endpoint.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/settings/authorized-keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/settings/authorized-keys')",
+ "html": "await octokit.request('GET /setup/api/settings/authorized-keys')\n
"
+ }
+ ],
+ "summary": "Get all authorized SSH keys",
+ "description": "",
+ "operationId": "enterprise-admin/get-all-authorized-ssh-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-all-authorized-ssh-keys"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-all-authorized-ssh-keys",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/settings/authorized-keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})",
+ "html": "await octokit.request('POST /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})\n
"
+ }
+ ],
+ "summary": "Add an authorized SSH key",
+ "description": "",
+ "operationId": "enterprise-admin/add-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#add-an-authorized-ssh-key"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "add-an-authorized-ssh-key",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/setup/api/settings/authorized-keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})",
+ "html": "await octokit.request('DELETE /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})\n
"
+ }
+ ],
+ "summary": "Remove an authorized SSH key",
+ "description": "",
+ "operationId": "enterprise-admin/remove-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#remove-an-authorized-ssh-key"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "remove-an-authorized-ssh-key",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/start",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/start', {\n license: 'license'\n})",
+ "html": "await octokit.request('POST /setup/api/start', {\n license: 'license'\n})\n
"
+ }
+ ],
+ "summary": "Create a GitHub license",
+ "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-settings).",
+ "operationId": "enterprise-admin/create-enterprise-server-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-a-github-enterprise-server-license"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "Required. The content of your .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your _.ghl_ license file.",
+ "childParamsGroups": []
+ },
+ "password": {
+ "type": "string",
+ "description": "You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.",
+ "childParamsGroups": []
+ },
+ "settings": {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An optional JSON string containing the installation settings.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "license"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "create-a-github-license",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "descriptionHTML": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\n\n- If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.
\n- If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.
\n
\nFor a list of the available settings, see the Get settings endpoint.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The content of your .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your _.ghl_ license file.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An optional JSON string containing the installation settings.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/upgrade",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/upgrade', {\n license: 'license'\n})",
+ "html": "await octokit.request('POST /setup/api/upgrade', {\n license: 'license'\n})\n
"
+ }
+ ],
+ "summary": "Upgrade a license",
+ "description": "This API upgrades your license and also triggers the configuration process:",
+ "operationId": "enterprise-admin/upgrade-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#upgrade-a-license"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your new .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your new _.ghl_ license file.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "upgrade-a-license",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "descriptionHTML": "This API upgrades your license and also triggers the configuration process:
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The content of your new .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your new _.ghl_ license file.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a team",
+ "description": "",
+ "operationId": "teams/get",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#get-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "get-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/teams/{team_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /teams/{team_id}', {\n team_id: 42,\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /teams/{team_id}', {\n team_id: 42,\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update a team",
+ "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.",
+ "operationId": "teams/update",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#update-a-team"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the team.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the team.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor 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.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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.",
+ "childParamsGroups": []
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "update-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "descriptionHTML": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the team.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor 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.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}', {\n team_id: 42\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a team",
+ "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well.",
+ "operationId": "teams/delete",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#delete-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "delete-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner and you pass the hellcat-preview media type, deleting a parent team will delete all of its child teams as well.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions', {\n team_id: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions', {\n team_id: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List discussions",
+ "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/list-discussions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#list-discussions"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "list-discussions",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 0,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": null,\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Our first team post\",\n \"updated_at\": \"2018-01-25T18:56:31Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions', {\n team_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions', {\n team_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a discussion",
+ "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "teams/create-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-discussion"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required. The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ]
+ },
+ "example": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "create-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "descriptionHTML": "Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 0,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": null,\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Our first team post\",\n \"updated_at\": \"2018-01-25T18:56:31Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a discussion",
+ "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/get-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-a-discussion"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "get-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 0,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": null,\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Our first team post\",\n \"updated_at\": \"2018-01-25T18:56:31Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n title: 'title',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n title: 'title',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a discussion",
+ "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/update-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#update-a-discussion"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "Welcome to our first team post"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "update-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 1,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Welcome to our first team post\",\n \"updated_at\": \"2018-01-26T18:22:20Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a discussion",
+ "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/delete-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#delete-a-discussion"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "delete-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List discussion comments",
+ "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/list-discussion-comments",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#list-discussion-comments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "list-discussion-comments",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like apples?\",\n \"body_html\": \"<p>Do you like apples?</p>\",\n \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": null,\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-15T23:53:58Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42,\n body: 'body',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42,\n body: 'body',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a discussion comment",
+ "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "teams/create-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-discussion-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Do you like apples?"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "create-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "descriptionHTML": "Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like apples?\",\n \"body_html\": \"<p>Do you like apples?</p>\",\n \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": null,\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-15T23:53:58Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a discussion comment",
+ "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/get-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-a-discussion-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "get-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like apples?\",\n \"body_html\": \"<p>Do you like apples?</p>\",\n \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": null,\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-15T23:53:58Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n body: 'body',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n body: 'body',\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a discussion comment",
+ "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/update-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#update-a-discussion-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Do you like pineapples?"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "update-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "descriptionHTML": "Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like pineapples?\",\n \"body_html\": \"<p>Do you like pineapples?</p>\",\n \"body_version\": \"e6907b24d9c93cc0c5024a7af5888116\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-26T18:22:20Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'echo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a discussion comment",
+ "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/delete-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#delete-a-discussion-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "delete-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a team discussion comment",
+ "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "reactions/list-for-team-discussion-comment",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-team-discussion-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-preview+json
"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-a-team-discussion-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a team discussion comment",
+ "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
+ "operationId": "reactions/create-for-team-discussion-comment",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-team-discussion-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the team discussion comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-preview+json
"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-a-team-discussion-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the team discussion comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a team discussion",
+ "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "reactions/list-for-team-discussion",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-team-discussion"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-preview+json
"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-a-team-discussion",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.echo-preview+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'echo',\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a team discussion",
+ "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.",
+ "operationId": "reactions/create-for-team-discussion",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-team-discussion"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the team discussion.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```",
+ "html": "The team discussions API is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.echo-preview+json
"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-a-team-discussion",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the team discussion.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/members",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filters members returned by their role in the team. Can be one of:
\n* member - normal members of the team.
\n* maintainer - team maintainers.
\n* all - all members of the team.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/members', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/members', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List team members",
+ "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "operationId": "teams/list-members",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#list-team-members"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "list-team-members",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If you pass the hellcat-preview media type, team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get team member (Legacy)",
+ "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-team-member-legacy"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true,
+ "slug": "get-team-member-legacy",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if user is a member"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if user is not a member"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "The \"Get team member\" endpoint (described below) is deprecated.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
"
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Add team member (Legacy)",
+ "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server 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 Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-team-member-legacy"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true,
+ "slug": "add-team-member-legacy",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if team synchronization is set up"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if you attempt to add an organization to a team",
+ "payload": "{\n \"message\": \"Cannot add an organization as a member.\",\n \"errors\": [\n {\n \"code\": \"org\",\n \"field\": \"user\",\n \"resource\": \"TeamMember\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "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",
+ "payload": "{\n \"message\": \"User isn't a member of this organization. Please invite them first.\",\n \"errors\": [\n {\n \"code\": \"unaffiliated\",\n \"field\": \"user\",\n \"resource\": \"TeamMember\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove team member (Legacy)",
+ "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server 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 Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#remove-team-member-legacy"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true,
+ "slug": "remove-team-member-legacy",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if team synchronization is setup"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "The \"Remove team member\" endpoint (described below) is deprecated.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get team membership for a user",
+ "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-team).",
+ "operationId": "teams/get-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-team-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "get-team-membership-for-a-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If you pass the hellcat-preview media type, team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has an active membership with team",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"active\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user is a team maintainer",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"maintainer\",\n \"state\": \"active\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has a pending membership with team",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"pending\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username',\n role: 'role'\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username',\n role: 'role'\n})\n
"
+ }
+ ],
+ "summary": "Add or update team membership for a user",
+ "description": "If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.",
+ "operationId": "teams/add-or-update-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-or-update-team-membership-for-a-user"
+ },
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "add-or-update-team-membership-for-a-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "descriptionHTML": "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.
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
",
+ "bodyParameters": [
+ {
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user's membership with team is now active",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"active\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user's membership with team is now pending",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"pending\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if you attempt to add an organization to a team",
+ "payload": "{\n \"message\": \"Cannot add an organization as a member.\",\n \"errors\": [\n {\n \"code\": \"org\",\n \"field\": \"user\",\n \"resource\": \"TeamMember\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.",
+ "operationId": "teams/remove-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#remove-team-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "remove-team-membership-for-a-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/projects', {\n team_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/projects', {\n team_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List team projects",
+ "description": "Lists the organization projects for a team. If you are an [authenticated](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#authentication) site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
+ "operationId": "teams/list-projects",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-team-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-team-projects",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the organization projects for a team. If you are an authenticated site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/orgs/octocat\",\n \"url\": \"https://api.github.com/projects/1002605\",\n \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n \"id\": 1002605,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n \"name\": \"Organization Roadmap\",\n \"body\": \"High-level roadmap for the upcoming year.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-11T20:09:31Z\",\n \"updated_at\": \"2014-03-04T18:58:10Z\",\n \"organization_permission\": \"write\",\n \"private\": false,\n \"permissions\": {\n \"read\": true,\n \"write\": true,\n \"admin\": false\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Check team permissions for a project",
+ "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
+ "operationId": "teams/check-permissions-for-project",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#check-team-permissions-for-a-project"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "check-team-permissions-for-a-project",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Checks whether a team has read, write, or admin permissions for an organization project. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/orgs/octocat\",\n \"url\": \"https://api.github.com/projects/1002605\",\n \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n \"id\": 1002605,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n \"name\": \"Organization Roadmap\",\n \"body\": \"High-level roadmap for the upcoming year.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-11T20:09:31Z\",\n \"updated_at\": \"2014-03-04T18:58:10Z\",\n \"organization_permission\": \"write\",\n \"private\": false,\n \"permissions\": {\n \"read\": true,\n \"write\": true,\n \"admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if project is not managed by this team"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "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.",
+ "operationId": "teams/add-or-update-project-permissions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#add-or-update-team-project-permissions"
+ },
+ "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.\"
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited from a parent team.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "add-or-update-team-project-permissions",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "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.\"
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited from a parent team.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Response if the project is not owned by the organization",
+ "payload": "{\n \"message\": \"Must have admin rights to Repository.\",\n \"documentation_url\": \"https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-or-update-team-project-permissions\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42\n})\n
"
+ }
+ ],
+ "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. **Note:** This endpoint removes the project from the team, but does not delete it.",
+ "operationId": "teams/remove-project",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#remove-a-project-from-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "remove-a-project-from-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/repos', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/repos', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List team repositories",
+ "description": "**Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team.\n\nIf you are an [authenticated](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#authentication) site administrator for your Enterprise instance, you will be able to list all repositories for the team.",
+ "operationId": "teams/list-repos",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-team-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-team-repositories",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: If you pass the hellcat-preview media type, the response will include any repositories inherited through a parent team.
\nIf you are an authenticated site administrator for your Enterprise instance, you will be able to list all repositories for the team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Check team permissions for a repository",
+ "description": "**Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "operationId": "teams/check-permissions-for-repo",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#check-team-permissions-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "check-team-permissions-for-a-repository",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Alternative response with extra repository information"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if repository is managed by this team"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if repository is not managed by this team"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: If you pass the hellcat-preview media type, repositories inherited through a parent team will be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
"
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world',\n permission: 'permission'\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world',\n permission: 'permission'\n})\n
"
+ }
+ ],
+ "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.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "teams/add-or-update-repo-permissions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#add-or-update-team-repository-permissions"
+ },
+ "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.
\nIf no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited through a parent team.
",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "add-or-update-team-repository-permissions",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "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.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "bodyParameters": [
+ {
+ "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.
\nIf no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited through a parent team.
",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "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. NOTE: This does not delete the repository, it just removes it from the team.",
+ "operationId": "teams/remove-repo",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#remove-a-repository-from-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "remove-a-repository-from-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/teams', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/teams', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List child teams",
+ "description": "You must use the `hellcat-preview` media type to use this endpoint.",
+ "operationId": "teams/list-child",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-child-teams"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-child-teams",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "You must use the hellcat-preview media type to use this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if child teams exist",
+ "payload": "[\n {\n \"id\": 2,\n \"node_id\": \"MDQ6VGVhbTI=\",\n \"url\": \"https://api.github.com/teams/2\",\n \"name\": \"Original Roster\",\n \"slug\": \"original-roster\",\n \"description\": \"Started it all.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/2/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/2/repos\",\n \"parent\": {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n },\n \"html_url\": \"https://github.com/orgs/rails/teams/core\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user')",
+ "html": "await octokit.request('GET /user')\n
"
+ }
+ ],
+ "summary": "Get the authenticated user",
+ "description": "If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.\n\nIf the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#get-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "get-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If the authenticated user is authenticated through basic authentication or OAuth with the user scope, then the response lists public and private profile information.
\nIf the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with public and private profile information",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\",\n \"private_gists\": 81,\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"two_factor_authentication\": true,\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"collaborators\": 0\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with public profile information",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/user",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /user', {\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /user', {\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update the authenticated user",
+ "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/update-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#update-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The new name of the user.
",
+ "type": "string",
+ "example": "Omar Jahandar",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new name of the user.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "description": "The publicly visible email address of the user.
",
+ "type": "string",
+ "example": "omar@example.com",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address of the user.",
+ "childParamsGroups": []
+ },
+ "blog": {
+ "description": "The new blog URL of the user.
",
+ "type": "string",
+ "example": "blog.example.com",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blog URL of the user.",
+ "childParamsGroups": []
+ },
+ "twitter_username": {
+ "description": "The new Twitter username of the user.
",
+ "type": "string or null",
+ "example": "therealomarj",
+ "nullable": true,
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new Twitter username of the user.",
+ "childParamsGroups": []
+ },
+ "company": {
+ "description": "The new company of the user.
",
+ "type": "string",
+ "example": "Acme corporation",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new company of the user.",
+ "childParamsGroups": []
+ },
+ "location": {
+ "description": "The new location of the user.
",
+ "type": "string",
+ "example": "Berlin, Germany",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new location of the user.",
+ "childParamsGroups": []
+ },
+ "hireable": {
+ "description": "The new hiring availability of the user.
",
+ "type": "boolean",
+ "name": "hireable",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "The new hiring availability of the user.",
+ "childParamsGroups": []
+ },
+ "bio": {
+ "description": "The new short biography of the user.
",
+ "type": "string",
+ "name": "bio",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new short biography of the user.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "update-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "The new name of the user.
",
+ "type": "string",
+ "example": "Omar Jahandar",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new name of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The publicly visible email address of the user.
",
+ "type": "string",
+ "example": "omar@example.com",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new blog URL of the user.
",
+ "type": "string",
+ "example": "blog.example.com",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blog URL of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new Twitter username of the user.
",
+ "type": "string or null",
+ "example": "therealomarj",
+ "nullable": true,
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new Twitter username of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new company of the user.
",
+ "type": "string",
+ "example": "Acme corporation",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new company of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new location of the user.
",
+ "type": "string",
+ "example": "Berlin, Germany",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new location of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new hiring availability of the user.
",
+ "type": "boolean",
+ "name": "hireable",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "The new hiring availability of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new short biography of the user.
",
+ "type": "string",
+ "name": "bio",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new short biography of the user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\",\n \"private_gists\": 81,\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"two_factor_authentication\": true,\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"collaborators\": 0\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/emails')",
+ "html": "await octokit.request('GET /user/emails')\n
"
+ }
+ ],
+ "summary": "List email addresses for the authenticated user",
+ "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-emails-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-email-addresses-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "list-email-addresses-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"email\": \"octocat@github.com\",\n \"verified\": true,\n \"primary\": true,\n \"visibility\": \"public\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})",
+ "html": "await octokit.request('POST /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Add an email address for the authenticated user",
+ "description": "This endpoint is accessible with the `user` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/add-email-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#add-an-email-address-for-the-authenticated-user"
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "add-an-email-address-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint is accessible with the user scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "[\n {\n \"email\": \"octocat@octocat.org\",\n \"primary\": false,\n \"verified\": false,\n \"visibility\": \"public\"\n },\n {\n \"email\": \"octocat@github.com\",\n \"primary\": false,\n \"verified\": false,\n \"visibility\": null\n },\n {\n \"email\": \"mona@github.com\",\n \"primary\": false,\n \"verified\": false,\n \"visibility\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})",
+ "html": "await octokit.request('DELETE /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Delete an email address for the authenticated user",
+ "description": "This endpoint is accessible with the `user` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-email-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "delete-an-email-address-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint is accessible with the user scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/followers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/followers')",
+ "html": "await octokit.request('GET /user/followers')\n
"
+ }
+ ],
+ "summary": "List followers of the authenticated user",
+ "description": "Lists the people following the authenticated user.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followers-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-followers-of-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-followers-of-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people following the authenticated user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/following",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/following')",
+ "html": "await octokit.request('GET /user/following')\n
"
+ }
+ ],
+ "summary": "List the people the authenticated user follows",
+ "description": "Lists the people who the authenticated user follows.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followed-by-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-the-people-the-authenticated-user-follows"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-the-people-the-authenticated-user-follows",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people who the authenticated user follows.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/following/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/following/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /user/following/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Check if a person is followed by the authenticated user",
+ "description": "",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-person-is-followed-by-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "check-if-a-person-is-followed-by-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if the person is followed by the authenticated user"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if the person is not followed by the authenticated user"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/user/following/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /user/following/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /user/following/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Follow a user",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/follow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#follow-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "follow-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/following/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/following/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /user/following/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Unfollow a user",
+ "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/unfollow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#unfollow-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "unfollow-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/gpg_keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/gpg_keys')",
+ "html": "await octokit.request('GET /user/gpg_keys')\n
"
+ }
+ ],
+ "summary": "List GPG keys for the authenticated user",
+ "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "list-gpg-keys-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"raw_key\": \"string\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/gpg_keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/gpg_keys', {\n armored_public_key: 'armored_public_key'\n})",
+ "html": "await octokit.request('POST /user/gpg_keys', {\n armored_public_key: 'armored_public_key'\n})\n
"
+ }
+ ],
+ "summary": "Create a GPG key for the authenticated user",
+ "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "users/create-gpg-key-for-authenticated",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#create-a-gpg-key-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "armored_public_key": {
+ "description": "Required. A GPG key in ASCII-armored format.
",
+ "type": "string",
+ "name": "armored_public_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A GPG key in ASCII-armored format.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "armored_public_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "create-a-gpg-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "Required. A GPG key in ASCII-armored format.
",
+ "type": "string",
+ "name": "armored_public_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A GPG key in ASCII-armored format.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"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-----\\\"\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/gpg_keys/{gpg_key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "gpg_key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})",
+ "html": "await octokit.request('GET /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a GPG key for the authenticated user",
+ "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-gpg-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "get-a-gpg-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"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-----\\\"\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/gpg_keys/{gpg_key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "gpg_key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})",
+ "html": "await octokit.request('DELETE /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a GPG key for the authenticated user",
+ "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-gpg-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "delete-a-gpg-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/installations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/installations', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /user/installations', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List app installations accessible to the user access token",
+ "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "list-app-installations-accessible-to-the-user-access-token",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.
\nYou must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
\nYou can find the permissions for the installation under the permissions key.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 2,\n \"installations\": [\n {\n \"id\": 1,\n \"account\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"single_file_name\": \"config.yaml\",\n \"repository_selection\": \"all\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app_slug\": \"github-actions\"\n },\n {\n \"id\": 3,\n \"account\": {\n \"login\": \"octocat\",\n \"id\": 2,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"single_file_name\": \"config.yaml\",\n \"repository_selection\": \"all\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app_slug\": \"github-actions\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/installations/{installation_id}/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/installations/{installation_id}/repositories', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /user/installations/{installation_id}/repositories', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List repositories accessible to the user access token",
+ "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installation-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#list-repositories-accessible-to-the-user-access-token"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "list-repositories-accessible-to-the-user-access-token",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
\nYou must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe access the user has to each repository is included in the hash under the permissions key.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"repositories\": [\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add a repository to an app installation",
+ "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/add-repo-to-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#add-a-repository-to-an-app-installation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "add-a-repository-to-an-app-installation",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Add a single repository to an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or the OAuth Authorizations API or Basic Authentication to access this endpoint.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove a repository from an app installation",
+ "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/remove-repo-from-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#remove-a-repository-from-an-app-installation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "remove-a-repository-from-an-app-installation",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or the OAuth Authorizations API or Basic Authentication to access this endpoint.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/issues",
+ "serverUrl": "https://api.github.com",
+ "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"
+ },
+ "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/issues')",
+ "html": "await octokit.request('GET /user/issues')\n
"
+ }
+ ],
+ "summary": "List user account issues assigned to the authenticated user",
+ "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "list-user-account-issues-assigned-to-the-authenticated-user",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List issues across owned and member repositories assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/keys')",
+ "html": "await octokit.request('GET /user/keys')\n
"
+ }
+ ],
+ "summary": "List public SSH keys for the authenticated user",
+ "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "list-public-ssh-keys-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"id\": 2,\n \"url\": \"https://api.github.com/user/keys/2\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAA\",\n \"created_at\": \"2020-06-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n },\n {\n \"key_id\": \"012345678912345608\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\n \"id\": 3,\n \"url\": \"https://api.github.com/user/keys/3\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAB\",\n \"created_at\": \"2020-07-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/keys', {\n key: 'key'\n})",
+ "html": "await octokit.request('POST /user/keys', {\n key: 'key'\n})\n
"
+ }
+ ],
+ "summary": "Create a public SSH key for the authenticated user",
+ "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "users/create-public-ssh-key-for-authenticated",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "A descriptive name for the new key.
",
+ "type": "string",
+ "example": "Personal MacBook Air",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A descriptive name for the new key.",
+ "childParamsGroups": []
+ },
+ "key": {
+ "description": "Required. The public SSH key to add to your GitHub account.
",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The public SSH key to add to your GitHub account.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "create-a-public-ssh-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "A descriptive name for the new key.
",
+ "type": "string",
+ "example": "Personal MacBook Air",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A descriptive name for the new key.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Required. The public SSH key to add to your GitHub account.
",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The public SSH key to add to your GitHub account.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"id\": 2,\n \"url\": \"https://api.github.com/user/keys/2\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAA\",\n \"created_at\": \"2020-06-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/keys/{key_id}', {\n key_id: 42\n})",
+ "html": "await octokit.request('GET /user/keys/{key_id}', {\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a public SSH key for the authenticated user",
+ "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-public-ssh-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "get-a-public-ssh-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"id\": 2,\n \"url\": \"https://api.github.com/user/keys/2\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAA\",\n \"created_at\": \"2020-06-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/keys/{key_id}', {\n key_id: 42\n})",
+ "html": "await octokit.request('DELETE /user/keys/{key_id}', {\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a public SSH key for the authenticated user",
+ "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "delete-a-public-ssh-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/memberships/orgs",
+ "serverUrl": "https://api.github.com",
+ "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"
+ ]
+ },
+ "descriptionHTML": "Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/memberships/orgs')",
+ "html": "await octokit.request('GET /user/memberships/orgs')\n
"
+ }
+ ],
+ "summary": "List organization memberships for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-memberships-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "list-organization-memberships-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n },\n {\n \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n \"state\": \"pending\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/memberships/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/memberships/orgs/{org}', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /user/memberships/orgs/{org}', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "Get an organization membership for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "get-an-organization-membership-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n \"state\": \"pending\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/user/memberships/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /user/memberships/orgs/{org}', {\n org: 'org',\n state: 'state'\n})",
+ "html": "await octokit.request('PATCH /user/memberships/orgs/{org}', {\n org: 'org',\n state: 'state'\n})\n
"
+ }
+ ],
+ "summary": "Update an organization membership for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "Required. The state that the membership should be in. Only \"active\" will be accepted.
",
+ "enum": [
+ "active"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "state": "active"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "update-an-organization-membership-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The state that the membership should be in. Only \"active\" will be accepted.
",
+ "enum": [
+ "active"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/orgs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/orgs')",
+ "html": "await octokit.request('GET /user/orgs')\n
"
+ }
+ ],
+ "summary": "List organizations for the authenticated user",
+ "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#list-organizations-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "list-organizations-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List organizations for the authenticated user.
\nOAuth scope requirements
\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/projects', {\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /user/projects', {\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a user project",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#create-a-user-project"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Required. Name of the project
",
+ "example": "Week One Sprint",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project",
+ "childParamsGroups": []
+ },
+ "body": {
+ "description": "Body of the project
",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string or null",
+ "nullable": true,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Body of the project",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "create-a-user-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. Name of the project
",
+ "example": "Week One Sprint",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Body of the project
",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string or null",
+ "nullable": true,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Body of the project",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/users/octocat\",\n \"url\": \"https://api.github.com/projects/1002603\",\n \"html_url\": \"https://github.com/users/octocat/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002603/columns\",\n \"id\": 1002603,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDM=\",\n \"name\": \"My Projects\",\n \"body\": \"A board to manage my personal projects.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/public_emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/public_emails')",
+ "html": "await octokit.request('GET /user/public_emails')\n
"
+ }
+ ],
+ "summary": "List public email addresses for the authenticated user",
+ "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-emails-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "list-public-email-addresses-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"email\": \"octocat@github.com\",\n \"verified\": true,\n \"primary\": true,\n \"visibility\": \"public\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/repos",
+ "serverUrl": "https://api.github.com",
+ "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"
+ },
+ "descriptionHTML": "Can be one of all, public, or private.
"
+ },
+ {
+ "name": "affiliation",
+ "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "owner,collaborator,organization_member"
+ },
+ "descriptionHTML": "Comma-separated list of values. Can include:
\n* owner: Repositories that are owned by the authenticated user.
\n* collaborator: Repositories that the user has been added to as a collaborator.
\n* organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
"
+ },
+ {
+ "name": "type",
+ "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "owner",
+ "public",
+ "private",
+ "member"
+ ],
+ "default": "all"
+ },
+ "descriptionHTML": "Can be one of all, owner, public, private, member. Default: all
\nWill cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.
"
+ },
+ {
+ "name": "sort",
+ "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "full_name"
+ },
+ "descriptionHTML": "Can be one of created, updated, pushed, full_name.
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be one of asc or desc. Default: asc when using full_name, otherwise desc
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "before",
+ "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/repos')",
+ "html": "await octokit.request('GET /user/repos')\n
"
+ }
+ ],
+ "summary": "List repositories for the authenticated user",
+ "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repositories-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repositories-for-the-authenticated-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "418",
+ "httpStatusMessage": "I'm A Teapot",
+ "description": "Response definition missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/repos', {\n name: 'name'\n})",
+ "html": "await octokit.request('POST /user/repos', {\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Create a repository for the authenticated user",
+ "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#create-a-repository-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Required. The name of the repository.
",
+ "type": "string",
+ "example": "Team Environment",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "description": "A short description of the repository.
",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ "homepage": {
+ "description": "A URL with more information about the repository.
",
+ "type": "string",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "description": "Whether the repository is private or public.
",
+ "default": false,
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is private or public.",
+ "childParamsGroups": []
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether issues are enabled.",
+ "childParamsGroups": []
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether projects are enabled.",
+ "childParamsGroups": []
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the wiki is enabled.",
+ "childParamsGroups": []
+ },
+ "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",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ "auto_init": {
+ "description": "Whether the repository is initialized with a minimal README.
",
+ "default": false,
+ "type": "boolean",
+ "name": "auto_init",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is initialized with a minimal README.",
+ "childParamsGroups": []
+ },
+ "gitignore_template": {
+ "description": "The desired language or platform to apply to the .gitignore.
",
+ "example": "Haskell",
+ "type": "string",
+ "name": "gitignore_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The desired language or platform to apply to the .gitignore.",
+ "childParamsGroups": []
+ },
+ "license_template": {
+ "description": "The license keyword of the open source license for this repository.
",
+ "example": "mit",
+ "type": "string",
+ "name": "license_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The license keyword of the open source license for this repository.",
+ "childParamsGroups": []
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow squash merges for pull requests.",
+ "childParamsGroups": []
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow merge commits for pull requests.",
+ "childParamsGroups": []
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow rebase merges for pull requests.",
+ "childParamsGroups": []
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged
",
+ "default": false,
+ "type": "boolean",
+ "example": false,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to delete head branches when pull requests are merged",
+ "childParamsGroups": []
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_downloads",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether downloads are enabled.",
+ "childParamsGroups": []
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.
",
+ "default": false,
+ "type": "boolean",
+ "example": true,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/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://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "The is_template and template_repository keys are currently available for developer to preview. See 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 in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "create-a-repository-for-the-authenticated-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repository
",
+ "bodyParameters": [
+ {
+ "description": "Required. The name of the repository.
",
+ "type": "string",
+ "example": "Team Environment",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A short description of the repository.
",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL with more information about the repository.
",
+ "type": "string",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the repository is private or public.
",
+ "default": false,
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is private or public.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether issues are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether issues are enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether projects are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether projects are enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the wiki is enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the wiki is enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "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",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the repository is initialized with a minimal README.
",
+ "default": false,
+ "type": "boolean",
+ "name": "auto_init",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is initialized with a minimal README.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The desired language or platform to apply to the .gitignore.
",
+ "example": "Haskell",
+ "type": "string",
+ "name": "gitignore_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The desired language or platform to apply to the .gitignore.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The license keyword of the open source license for this repository.
",
+ "example": "mit",
+ "type": "string",
+ "name": "license_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The license keyword of the open source license for this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to allow squash merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow squash merges for pull requests.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to allow merge commits for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow merge commits for pull requests.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to allow rebase merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow rebase merges for pull requests.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to delete head branches when pull requests are merged
",
+ "default": false,
+ "type": "boolean",
+ "example": false,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to delete head branches when pull requests are merged",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether downloads are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_downloads",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether downloads are enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.
",
+ "default": false,
+ "type": "boolean",
+ "example": true,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/repository_invitations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/repository_invitations')",
+ "html": "await octokit.request('GET /user/repository_invitations')\n
"
+ }
+ ],
+ "summary": "List repository invitations for the authenticated user",
+ "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-invitations-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "list-repository-invitations-for-the-authenticated-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\",\n \"node_id\": \"MDQ6VXNlcjE=\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/user/repository_invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})",
+ "html": "await octokit.request('PATCH /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Accept a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/accept-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#accept-a-repository-invitation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "accept-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/repository_invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})",
+ "html": "await octokit.request('DELETE /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Decline a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/decline-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#decline-a-repository-invitation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "decline-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/starred",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/starred')",
+ "html": "await octokit.request('GET /user/starred')\n
"
+ }
+ ],
+ "summary": "List repositories starred by the authenticated user",
+ "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-starred-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "list-repositories-starred-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories the authenticated user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/starred/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Check if a repository is starred by the authenticated user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/check-repo-is-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "check-if-a-repository-is-starred-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if this repository is starred by you"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if this repository is not starred by you"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/user/starred/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('PUT /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Star a repository for the authenticated user",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/star-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#star-a-repository-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "star-a-repository-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/starred/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Unstar a repository for the authenticated user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/unstar-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#unstar-a-repository-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "unstar-a-repository-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/subscriptions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/subscriptions')",
+ "html": "await octokit.request('GET /user/subscriptions')\n
"
+ }
+ ],
+ "summary": "List repositories watched by the authenticated user",
+ "description": "Lists repositories the authenticated user is watching.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-watched-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-watched-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "list-repositories-watched-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories the authenticated user is watching.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/teams')",
+ "html": "await octokit.request('GET /user/teams')\n
"
+ }
+ ],
+ "summary": "List teams for the authenticated user",
+ "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-teams-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-teams-for-the-authenticated-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 when authenticating via OAuth.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null,\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "since",
+ "description": "A user ID. Only return users with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "A user ID. Only return users with an ID greater than this ID.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users')",
+ "html": "await octokit.request('GET /users')\n
"
+ }
+ ],
+ "summary": "List users",
+ "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#list-users"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "list-users",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get a user",
+ "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@2.18/rest/reference/users#emails)\".",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-by-username",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#get-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "get-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
\nThe email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"twitter_username\": \"monatheoctocat\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with GitHub plan information",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"twitter_username\": \"monatheoctocat\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\",\n \"plan\": {\n \"name\": \"pro\",\n \"space\": 976562499,\n \"collaborators\": 0,\n \"private_repos\": 9999\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/events', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/events', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List events for the authenticated user",
+ "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-events-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-events-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/events/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/events/orgs/{org}', {\n username: 'username',\n org: 'org'\n})",
+ "html": "await octokit.request('GET /users/{username}/events/orgs/{org}', {\n username: 'username',\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List organization events for the authenticated user",
+ "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-org-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-organization-events-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-organization-events-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This is the user's organization dashboard. You must be authenticated as the user to view this.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/events/public",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/events/public', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/events/public', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List public events for a user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-events-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-events-for-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/followers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/followers', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/followers', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List followers of a user",
+ "description": "Lists the people following the specified user.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followers-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-followers-of-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-followers-of-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people following the specified user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/following",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/following', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/following', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List the people a user follows",
+ "description": "Lists the people who the specified user follows.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-following-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-the-people-a-user-follows"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-the-people-a-user-follows",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people who the specified user follows.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/following/{target_user}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "target_user",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/following/{target_user}', {\n username: 'username',\n target_user: 'target_user'\n})",
+ "html": "await octokit.request('GET /users/{username}/following/{target_user}', {\n username: 'username',\n target_user: 'target_user'\n})\n
"
+ }
+ ],
+ "summary": "Check if a user follows another user",
+ "description": "",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-following-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#check-if-a-user-follows-another-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "check-if-a-user-follows-another-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if the user follows the target user"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if the user does not follow the target user"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/gists",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/gists', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/gists', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List gists for a user",
+ "description": "Lists public gists for the specified user:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#list-gists-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-gists-for-a-user",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists public gists for the specified user:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"files\": {\n \"hello_world.rb\": {\n \"filename\": \"hello_world.rb\",\n \"type\": \"application/x-ruby\",\n \"language\": \"Ruby\",\n \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n \"size\": 167\n }\n },\n \"public\": true,\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"user\": null,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"truncated\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/gpg_keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/gpg_keys', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/gpg_keys', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List GPG keys for a user",
+ "description": "Lists the GPG keys for a user. This information is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-gpg-keys-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "list-gpg-keys-for-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"raw_key\": \"string\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/hovercard",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ ]
+ },
+ "descriptionHTML": "Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.
"
+ },
+ {
+ "name": "subject_id",
+ "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Uses the ID for the subject_type you specified. Required when using subject_type.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/hovercard', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/hovercard', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get contextual information for a user",
+ "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-context-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#get-contextual-information-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "get-contextual-information-for-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThe subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:
\ncurl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"contexts\": [\n {\n \"message\": \"Owns this repository\",\n \"octicon\": \"repo\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/installation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/installation', {\n username: 'username',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /users/{username}/installation', {\n username: 'username',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a user installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-user-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-a-user-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-a-user-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"account\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"html_url\": \"https://github.com/github\",\n \"followers_url\": \"https://api.github.com/users/github/followers\",\n \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"repository_selection\": \"all\",\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"created_at\": \"2018-02-09T20:51:14Z\",\n \"updated_at\": \"2018-02-09T20:51:14Z\",\n \"single_file_name\": \"config.yml\",\n \"app_slug\": \"github-actions\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/keys', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/keys', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List public keys for a user",
+ "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-public-keys-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "list-public-keys-for-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/orgs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/orgs', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/orgs', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List organizations for a user",
+ "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#list-organizations-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "list-organizations-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/projects', {\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /users/{username}/projects', {\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List user projects",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#list-user-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "list-user-projects",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/users/octocat\",\n \"url\": \"https://api.github.com/projects/1002603\",\n \"html_url\": \"https://github.com/users/octocat/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002603/columns\",\n \"id\": 1002603,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDM=\",\n \"name\": \"My Projects\",\n \"body\": \"A board to manage my personal projects.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/received_events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/received_events', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/received_events', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List events received by the authenticated user",
+ "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-events-received-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-events-received-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/received_events/public",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/received_events/public', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/received_events/public', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List public events received by a user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-public-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-events-received-by-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-events-received-by-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "type",
+ "description": "Can be one of `all`, `owner`, `member`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "owner",
+ "member"
+ ],
+ "default": "owner"
+ },
+ "descriptionHTML": "Can be one of all, owner, member.
"
+ },
+ {
+ "name": "sort",
+ "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "full_name"
+ },
+ "descriptionHTML": "Can be one of created, updated, pushed, full_name.
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be one of asc or desc. Default: asc when using full_name, otherwise desc
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/repos', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/repos', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List repositories for a user",
+ "description": "Lists public repositories for the specified user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repositories-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.nebula-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repositories-for-a-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists public repositories for the specified user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/users/{username}/site_admin",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /users/{username}/site_admin', {\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /users/{username}/site_admin', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Promote a user to be a site administrator",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "enterprise-admin/promote-user-to-be-site-administrator",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#promote-a-user-to-be-a-site-administrator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "promote-a-user-to-be-a-site-administrator",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/users/{username}/site_admin",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /users/{username}/site_admin', {\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /users/{username}/site_admin', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Demote a site administrator",
+ "description": "You can demote any user account except your own.",
+ "operationId": "enterprise-admin/demote-site-administrator",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#demote-a-site-administrator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "demote-a-site-administrator",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "You can demote any user account except your own.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/starred",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/starred', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/starred', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List repositories starred by a user",
+ "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-starred-by-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "list-repositories-starred-by-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/subscriptions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/subscriptions', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/subscriptions', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List repositories watched by a user",
+ "description": "Lists repositories a user is watching.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-watched-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-watched-by-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "list-repositories-watched-by-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories a user is watching.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/users/{username}/suspended",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})",
+ "html": "await octokit.request('PUT /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})\n
"
+ }
+ ],
+ "summary": "Suspend a user",
+ "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "enterprise-admin/suspend-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#suspend-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "suspend-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
\nYou can suspend any user account except your own.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/users/{username}/suspended",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})",
+ "html": "await octokit.request('DELETE /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})\n
"
+ }
+ ],
+ "summary": "Unsuspend a user",
+ "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.",
+ "operationId": "enterprise-admin/unsuspend-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#unsuspend-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "unsuspend-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/zen",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /zen')",
+ "html": "await octokit.request('GET /zen')\n
"
+ }
+ ],
+ "summary": "Get the Zen of GitHub",
+ "description": "Get a random sentence from the Zen of GitHub",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get-zen",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "meta"
+ },
+ "slug": "get-the-zen-of-github",
+ "category": "meta",
+ "categoryLabel": "Meta",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a random sentence from the Zen of GitHub
"
+ }
+]
\ No newline at end of file
diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json
new file mode 100644
index 000000000000..e254f9473037
--- /dev/null
+++ b/lib/rest/static/decorated/ghes-2.19.json
@@ -0,0 +1,64048 @@
+[
+ {
+ "verb": "get",
+ "requestPath": "/",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /')",
+ "html": "await octokit.request('GET /')\n
"
+ }
+ ],
+ "summary": "GitHub API Root",
+ "description": "Get Hypermedia links to resources accessible in GitHub's REST API",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/root",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "meta"
+ },
+ "slug": "github-api-root",
+ "category": "meta",
+ "categoryLabel": "Meta",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/hooks', {\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/hooks', {\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List global webhooks",
+ "description": "",
+ "operationId": "enterprise-admin/list-global-webhooks",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-global-webhooks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.superpro-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ },
+ "slug": "list-global-webhooks",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "global-webhooks",
+ "subcategoryLabel": "Global webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"type\": \"Global\",\n \"id\": 1,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"organization\",\n \"user\"\n ],\n \"config\": {\n \"url\": \"https://example.com\",\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"secret\": \"********\"\n },\n \"updated_at\": \"2017-12-07T00:14:59Z\",\n \"created_at\": \"2017-12-07T00:14:59Z\",\n \"url\": \"https://api.github.com/admin/hooks/1\",\n \"ping_url\": \"https://api.github.com/admin/hooks/1/pings\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/hooks', {\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n },\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})",
+ "html": "await octokit.request('POST /admin/hooks', {\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n },\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/create-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-global-webhook"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. Must be passed as \"web\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Must be passed as \"web\".",
+ "childParamsGroups": []
+ },
+ "config": {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook.",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "config"
+ ]
+ },
+ "example": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.superpro-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ },
+ "slug": "create-a-global-webhook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "global-webhooks",
+ "subcategoryLabel": "Global webhooks",
+ "notes": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Global\",\n \"id\": 1,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"organization\",\n \"user\"\n ],\n \"config\": {\n \"url\": \"https://example.com\",\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"secret\": \"********\"\n },\n \"updated_at\": \"2017-12-07T00:14:59Z\",\n \"created_at\": \"2017-12-07T00:14:59Z\",\n \"url\": \"https://api.github.com/admin/hooks/1\",\n \"ping_url\": \"https://api.github.com/admin/hooks/1/pings\"\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. Must be passed as \"web\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Must be passed as \"web\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook.",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/hooks/{hook_id}', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/hooks/{hook_id}', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/get-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-global-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.superpro-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ },
+ "slug": "get-a-global-webhook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "global-webhooks",
+ "subcategoryLabel": "Global webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Global\",\n \"id\": 1,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"organization\",\n \"user\"\n ],\n \"config\": {\n \"url\": \"https://example.com\",\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"secret\": \"********\"\n },\n \"updated_at\": \"2017-12-07T00:14:59Z\",\n \"created_at\": \"2017-12-07T00:14:59Z\",\n \"url\": \"https://api.github.com/admin/hooks/1\",\n \"ping_url\": \"https://api.github.com/admin/hooks/1/pings\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/hooks/{hook_id}', {\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n },\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /admin/hooks/{hook_id}', {\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n },\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a global webhook",
+ "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.",
+ "operationId": "enterprise-admin/update-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-a-global-webhook"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook.",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.superpro-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ },
+ "slug": "update-a-global-webhook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "global-webhooks",
+ "subcategoryLabel": "Global webhooks",
+ "notes": [],
+ "descriptionHTML": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Global\",\n \"id\": 1,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"organization\"\n ],\n \"config\": {\n \"url\": \"https://example.com\",\n \"content_type\": \"form\",\n \"insecure_ssl\": \"0\"\n },\n \"updated_at\": \"2017-12-07T00:14:59Z\",\n \"created_at\": \"2017-12-07T00:14:59Z\",\n \"url\": \"https://api.github.com/admin/hooks/1\",\n \"ping_url\": \"https://api.github.com/admin/hooks/1/pings\"\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook.",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "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 header.
",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers) header.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/hooks/{hook_id}', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /admin/hooks/{hook_id}', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/delete-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-global-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.superpro-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ },
+ "slug": "delete-a-global-webhook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "global-webhooks",
+ "subcategoryLabel": "Global webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/hooks/{hook_id}/pings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.superpro-preview+json\" \\\n https://api.github.com/admin/hooks/42/pings
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/hooks/{hook_id}/pings', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})",
+ "html": "await octokit.request('POST /admin/hooks/{hook_id}/pings', {\n hook_id: 42,\n mediaType: {\n previews: [\n 'superpro'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Ping a global webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.19/webhooks/#ping-event) to be sent to the webhook.",
+ "operationId": "enterprise-admin/ping-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#ping-a-global-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```",
+ "html": "The Global Webhooks API is currently available for developers to preview. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.superpro-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ },
+ "slug": "ping-a-global-webhook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "global-webhooks",
+ "subcategoryLabel": "Global webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This will trigger a ping event to be sent to the webhook.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/keys')",
+ "html": "await octokit.request('GET /admin/keys')\n
"
+ }
+ ],
+ "summary": "List public keys",
+ "description": "",
+ "operationId": "enterprise-admin/list-public-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-public-keys"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "list-public-keys",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"user_id\": 232,\n \"repository_id\": null\n },\n {\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"user_id\": null,\n \"repository_id\": 2333,\n \"id\": \"2\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/2\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/keys/{key_ids}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "key_ids",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/keys/KEY_IDS
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/keys/{key_ids}', {\n key_ids: 'key_ids'\n})",
+ "html": "await octokit.request('DELETE /admin/keys/{key_ids}', {\n key_ids: 'key_ids'\n})\n
"
+ }
+ ],
+ "summary": "Delete a public key",
+ "description": "",
+ "operationId": "enterprise-admin/delete-public-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-public-key"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "delete-a-public-key",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/ldap/teams/{team_id}/mapping",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/ldap/teams/{team_id}/mapping', {\n team_id: 42,\n ldap_dn: 'ldap_dn'\n})",
+ "html": "await octokit.request('PATCH /admin/ldap/teams/{team_id}/mapping', {\n team_id: 42,\n ldap_dn: 'ldap_dn'\n})\n
"
+ }
+ ],
+ "summary": "Update LDAP mapping for a team",
+ "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@2.19/v3/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.",
+ "operationId": "enterprise-admin/update-ldap-mapping-for-team",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string",
+ "description": "The distinguished name (DN) of the LDAP entry to map to a team.
",
+ "name": "ldap_dn",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ },
+ "slug": "update-ldap-mapping-for-a-team",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "ldap",
+ "subcategoryLabel": "Ldap",
+ "notes": [],
+ "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
\nIf you pass the hellcat-preview media type, you can also update the LDAP mapping of a child team.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The distinguished name (DN) of the LDAP entry to map to a team.
",
+ "name": "ldap_dn",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"ldap_dn\": \"cn=Enterprise Ops,ou=teams,dc=github,dc=com\",\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/ldap/teams/{team_id}/sync",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/teams/42/sync
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/ldap/teams/{team_id}/sync', {\n team_id: 42\n})",
+ "html": "await octokit.request('POST /admin/ldap/teams/{team_id}/sync', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Sync LDAP mapping for a team",
+ "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
+ "operationId": "enterprise-admin/sync-ldap-mapping-for-team",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ },
+ "slug": "sync-ldap-mapping-for-a-team",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "ldap",
+ "subcategoryLabel": "Ldap",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response",
+ "payload": "{\n \"status\": \"queued\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/ldap/users/{username}/mapping",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/mapping \\\n -d '{\"ldap_dn\":\"ldap_dn\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/ldap/users/{username}/mapping', {\n username: 'username',\n ldap_dn: 'ldap_dn'\n})",
+ "html": "await octokit.request('PATCH /admin/ldap/users/{username}/mapping', {\n username: 'username',\n ldap_dn: 'ldap_dn'\n})\n
"
+ }
+ ],
+ "summary": "Update LDAP mapping for a user",
+ "description": "",
+ "operationId": "enterprise-admin/update-ldap-mapping-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string",
+ "description": "The distinguished name (DN) of the LDAP entry to map to a team.
",
+ "name": "ldap_dn",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ },
+ "slug": "update-ldap-mapping-for-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "ldap",
+ "subcategoryLabel": "Ldap",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The distinguished name (DN) of the LDAP entry to map to a team.
",
+ "name": "ldap_dn",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\",\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/ldap/users/{username}/sync",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/ldap/users/USERNAME/sync
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/ldap/users/{username}/sync', {\n username: 'username'\n})",
+ "html": "await octokit.request('POST /admin/ldap/users/{username}/sync', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Sync LDAP mapping for a user",
+ "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
+ "operationId": "enterprise-admin/sync-ldap-mapping-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ },
+ "slug": "sync-ldap-mapping-for-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "ldap",
+ "subcategoryLabel": "Ldap",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response",
+ "payload": "{\n \"status\": \"queued\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/organizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/organizations', {\n login: 'login',\n admin: 'admin'\n})",
+ "html": "await octokit.request('POST /admin/organizations', {\n login: 'login',\n admin: 'admin'\n})\n
"
+ }
+ ],
+ "summary": "Create an organization",
+ "description": "",
+ "operationId": "enterprise-admin/create-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-an-organization"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "Required. The organization's username.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's username.",
+ "childParamsGroups": []
+ },
+ "admin": {
+ "type": "string",
+ "description": "Required. The login of the user who will manage this organization.
",
+ "name": "admin",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The login of the user who will manage this organization.",
+ "childParamsGroups": []
+ },
+ "profile_name": {
+ "type": "string",
+ "description": "The organization's display name.
",
+ "name": "profile_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's display name.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "login",
+ "admin"
+ ]
+ },
+ "example": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ },
+ "slug": "create-an-organization",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "orgs",
+ "subcategoryLabel": "Orgs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The organization's username.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's username.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The login of the user who will manage this organization.
",
+ "name": "admin",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The login of the user who will manage this organization.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The organization's display name.
",
+ "name": "profile_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's display name.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/organizations/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/organizations/ORG \\\n -d '{\"login\":\"login\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/organizations/{org}', {\n org: 'org',\n login: 'login'\n})",
+ "html": "await octokit.request('PATCH /admin/organizations/{org}', {\n org: 'org',\n login: 'login'\n})\n
"
+ }
+ ],
+ "summary": "Update an organization name",
+ "description": "",
+ "operationId": "enterprise-admin/update-org-name",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-an-organization-name"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "Required. The organization's new name.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's new name.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "the-new-octocats"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ },
+ "slug": "update-an-organization-name",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "orgs",
+ "subcategoryLabel": "Orgs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The organization's new name.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The organization's new name.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response",
+ "payload": "{\n \"message\": \"Job queued to rename organization. It may take a few minutes to complete.\",\n \"url\": \"https://<hostname>/api/v3/organizations/1\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/pre-receive-environments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/pre-receive-environments', {\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/pre-receive-environments', {\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List pre-receive environments",
+ "description": "",
+ "operationId": "enterprise-admin/list-pre-receive-environments",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-pre-receive-environments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "list-pre-receive-environments",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"name\": \"Default\",\n \"image_url\": \"githubenterprise://internal\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/1\",\n \"default_environment\": true,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 14,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\n \"state\": \"not_started\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n },\n {\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/pre-receive-environments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/pre-receive-environments', {\n name: 'name',\n image_url: 'image_url',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('POST /admin/pre-receive-environments', {\n name: 'name',\n image_url: 'image_url',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a pre-receive environment",
+ "description": "",
+ "operationId": "enterprise-admin/create-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-pre-receive-environment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The new pre-receive environment's name.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new pre-receive environment's name.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. URL from which to download a tarball of this environment.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "URL from which to download a tarball of this environment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "image_url"
+ ]
+ },
+ "example": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "create-a-pre-receive-environment",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The new pre-receive environment's name.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new pre-receive environment's name.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. URL from which to download a tarball of this environment.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "URL from which to download a tarball of this environment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"not_started\",\n \"downloaded_at\": null,\n \"message\": null\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a pre-receive environment",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-pre-receive-environment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "get-a-pre-receive-environment",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a pre-receive environment",
+ "description": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.",
+ "operationId": "enterprise-admin/update-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-a-pre-receive-environment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This pre-receive environment's new name.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "This pre-receive environment's new name.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "URL from which to download a tarball of this environment.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "update-a-pre-receive-environment",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "descriptionHTML": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "This pre-receive environment's new name.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "This pre-receive environment's new name.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "URL from which to download a tarball of this environment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Client errors",
+ "payload": "{\n \"message\": \"Validation Failed\",\n \"errors\": [\n {\n \"resource\": \"PreReceiveEnvironment\",\n \"code\": \"custom\",\n \"message\": \"Cannot modify or delete the default environment\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /admin/pre-receive-environments/{pre_receive_environment_id}', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a pre-receive environment",
+ "description": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_",
+ "operationId": "enterprise-admin/delete-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-pre-receive-environment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "delete-a-pre-receive-environment",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.
\nThe possible error messages are:
\n\n- Cannot modify or delete the default environment
\n- Cannot delete environment that has hooks
\n- Cannot delete environment when download is in progress
\n
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Client errors",
+ "payload": "{\n \"message\": \"Validation Failed\",\n \"errors\": [\n {\n \"resource\": \"PreReceiveEnvironment\",\n \"code\": \"custom\",\n \"message\": \"Cannot modify or delete the default environment\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Start a pre-receive environment download",
+ "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_",
+ "operationId": "enterprise-admin/start-pre-receive-environment-download",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#start-a-pre-receive-environment-download"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "start-a-pre-receive-environment-download",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Triggers a new download of the environment tarball from the environment's image_url. When the download is finished, the newly downloaded tarball will overwrite the existing environment.
\nIf a download cannot be triggered, you will receive a 422 Unprocessable Entity response.
\nThe possible error messages are:
\n\n- Cannot modify or delete the default environment
\n- Can not start a new download when a download is in progress
\n
",
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\n \"state\": \"not_started\",\n \"downloaded_at\": null,\n \"message\": null\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Client errors",
+ "payload": "{\n \"message\": \"Validation Failed\",\n \"errors\": [\n {\n \"resource\": \"PreReceiveEnvironment\",\n \"code\": \"custom\",\n \"message\": \"Can not start a new download when a download is in progress\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-environments/42/downloads/latest
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest', {\n pre_receive_environment_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get the download status for a pre-receive environment",
+ "description": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.",
+ "operationId": "enterprise-admin/get-download-status-for-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ },
+ "slug": "get-the-download-status-for-a-pre-receive-environment",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-environments",
+ "subcategoryLabel": "Pre receive environments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/pre-receive-hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/pre-receive-hooks', {\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/pre-receive-hooks', {\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List pre-receive hooks",
+ "description": "",
+ "operationId": "enterprise-admin/list-pre-receive-hooks",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-pre-receive-hooks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ },
+ "slug": "list-pre-receive-hooks",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-hooks",
+ "subcategoryLabel": "Pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"script\": \"scripts/commmit_check.sh\",\n \"script_repository\": {\n \"id\": 595,\n \"full_name\": \"DevIT/hooks\",\n \"url\": \"https://github.example.com/api/v3/repos/DevIT/hooks\",\n \"html_url\": \"https://github.example.com/DevIT/hooks\"\n },\n \"environment\": {\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n },\n \"allow_downstream_configuration\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/pre-receive-hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":{},\"environment\":{}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/pre-receive-hooks', {\n name: 'name',\n script: 'script',\n script_repository: {},\n environment: {},\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('POST /admin/pre-receive-hooks', {\n name: 'name',\n script: 'script',\n script_repository: {},\n environment: {},\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/create-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-pre-receive-hook"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the hook.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the hook.",
+ "childParamsGroups": []
+ },
+ "script": {
+ "type": "string",
+ "description": "Required. The script that the hook runs.
",
+ "name": "script",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The script that the hook runs.",
+ "childParamsGroups": []
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "Required. The GitHub repository where the script is kept.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "script_repository",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The GitHub repository where the script is kept.",
+ "childParamsGroups": []
+ },
+ "environment": {
+ "type": "object",
+ "description": "Required. The pre-receive environment where the script is executed.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "environment",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The pre-receive environment where the script is executed.",
+ "childParamsGroups": []
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook. default: disabled
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook. default: `disabled`",
+ "childParamsGroups": []
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level. default: false
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "script",
+ "script_repository",
+ "environment"
+ ]
+ },
+ "example": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ },
+ "slug": "create-a-pre-receive-hook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-hooks",
+ "subcategoryLabel": "Pre receive hooks",
+ "notes": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"script\": \"scripts/commmit_check.sh\",\n \"script_repository\": {\n \"id\": 595,\n \"full_name\": \"DevIT/hooks\",\n \"url\": \"https://github.example.com/api/v3/repos/DevIT/hooks\",\n \"html_url\": \"https://github.example.com/DevIT/hooks\"\n },\n \"environment\": {\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n },\n \"allow_downstream_configuration\": false\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the hook.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the hook.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The script that the hook runs.
",
+ "name": "script",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The script that the hook runs.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "Required. The GitHub repository where the script is kept.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "script_repository",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The GitHub repository where the script is kept.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "Required. The pre-receive environment where the script is executed.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "environment",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The pre-receive environment where the script is executed.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of enforcement for this hook. default: disabled
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook. default: `disabled`",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level. default: false
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level. default: `false`",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/pre-receive-hooks/{pre_receive_hook_id}', {\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /admin/pre-receive-hooks/{pre_receive_hook_id}', {\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-pre-receive-hook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ },
+ "slug": "get-a-pre-receive-hook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-hooks",
+ "subcategoryLabel": "Pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"script\": \"scripts/commmit_check.sh\",\n \"script_repository\": {\n \"id\": 595,\n \"full_name\": \"DevIT/hooks\",\n \"url\": \"https://github.example.com/api/v3/repos/DevIT/hooks\",\n \"html_url\": \"https://github.example.com/DevIT/hooks\"\n },\n \"environment\": {\n \"id\": 2,\n \"name\": \"DevTools Hook Env\",\n \"image_url\": \"https://my_file_server/path/to/devtools_env.tar.gz\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/2\",\n \"default_environment\": false,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n },\n \"allow_downstream_configuration\": false\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}', {\n pre_receive_hook_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}', {\n pre_receive_hook_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/update-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-a-pre-receive-hook"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the hook.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the hook.",
+ "childParamsGroups": []
+ },
+ "script": {
+ "type": "string",
+ "description": "The script that the hook runs.
",
+ "name": "script",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The script that the hook runs.",
+ "childParamsGroups": []
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "script_repository",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The GitHub repository where the script is kept.",
+ "childParamsGroups": []
+ },
+ "environment": {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "environment",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The pre-receive environment where the script is executed.",
+ "childParamsGroups": []
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook.
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook.",
+ "childParamsGroups": []
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level.
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ },
+ "slug": "update-a-pre-receive-hook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-hooks",
+ "subcategoryLabel": "Pre receive hooks",
+ "notes": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"script\": \"scripts/commmit_check.sh\",\n \"script_repository\": {\n \"id\": 595,\n \"full_name\": \"DevIT/hooks\",\n \"url\": \"https://github.example.com/api/v3/repos/DevIT/hooks\",\n \"html_url\": \"https://github.example.com/DevIT/hooks\"\n },\n \"environment\": {\n \"id\": 1,\n \"name\": \"Default\",\n \"image_url\": \"githubenterprise://internal\",\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\n \"html_url\": \"https://github.example.com/admin/pre-receive-environments/1\",\n \"default_environment\": true,\n \"created_at\": \"2016-05-20T11:35:45-05:00\",\n \"hooks_count\": 1,\n \"download\": {\n \"url\": \"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\n \"state\": \"success\",\n \"downloaded_at\": \"2016-05-26T07:42:53-05:00\",\n \"message\": null\n }\n },\n \"allow_downstream_configuration\": true\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The name of the hook.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the hook.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The script that the hook runs.
",
+ "name": "script",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The script that the hook runs.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "script_repository",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The GitHub repository where the script is kept.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.
",
+ "properties": {},
+ "additionalProperties": true,
+ "name": "environment",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The pre-receive environment where the script is executed.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of enforcement for this hook.
",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for this hook.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level.
",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether enforcement can be overridden at the org or repo level.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/admin/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}', {\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}', {\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/delete-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-pre-receive-hook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ },
+ "slug": "delete-a-pre-receive-hook",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "pre-receive-hooks",
+ "subcategoryLabel": "Pre receive hooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/admin/tokens",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /admin/tokens')",
+ "html": "await octokit.request('GET /admin/tokens')\n
"
+ }
+ ],
+ "summary": "List personal access tokens",
+ "description": "Lists personal access tokens for all users, including admin users.",
+ "operationId": "enterprise-admin/list-personal-access-tokens",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-personal-access-tokens"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "list-personal-access-tokens",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists personal access tokens for all users, including admin users.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 2,\n \"url\": \"https://enterprise.octocat.com/api/v3/authorizations/2\",\n \"app\": {\n \"name\": \"My personal access token\",\n \"url\": \"https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens\",\n \"client_id\": \"00000000000000000000\"\n },\n \"token\": \"\",\n \"hashed_token\": \"23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45\",\n \"token_last_eight\": \"848f9f8a\",\n \"note\": \"My personal access token\",\n \"note_url\": null,\n \"created_at\": \"2019-04-24T21:49:02Z\",\n \"updated_at\": \"2019-04-24T21:49:02Z\",\n \"scopes\": [\n \"admin:business\",\n \"admin:gpg_key\",\n \"admin:org\",\n \"admin:org_hook\",\n \"admin:pre_receive_hook\",\n \"admin:public_key\",\n \"admin:repo_hook\",\n \"delete_repo\",\n \"gist\",\n \"notifications\",\n \"repo\",\n \"user\",\n \"write:discussion\"\n ],\n \"fingerprint\": null\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/tokens/{token_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "token_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/tokens/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/tokens/{token_id}', {\n token_id: 42\n})",
+ "html": "await octokit.request('DELETE /admin/tokens/{token_id}', {\n token_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a personal access token",
+ "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.",
+ "operationId": "enterprise-admin/delete-personal-access-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-personal-access-token"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "delete-a-personal-access-token",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users \\\n -d '{\"login\":\"login\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/users', {\n login: 'login'\n})",
+ "html": "await octokit.request('POST /admin/users', {\n login: 'login'\n})\n
"
+ }
+ ],
+ "summary": "Create a user",
+ "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.",
+ "operationId": "enterprise-admin/create-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "Required. The user's username.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The user's username.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://help.github.com/enterprise/2.19/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "create-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "descriptionHTML": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.
\nIf the login name or email address is already associated with an account, the server will return a 422 response.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The user's username.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The user's username.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required for built-in authentication. The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://help.github.com/enterprise/2.19/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/admin/users/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME \\\n -d '{\"login\":\"login\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /admin/users/{username}', {\n username: 'username',\n login: 'login'\n})",
+ "html": "await octokit.request('PATCH /admin/users/{username}', {\n username: 'username',\n login: 'login'\n})\n
"
+ }
+ ],
+ "summary": "Update the username for a user",
+ "description": "",
+ "operationId": "enterprise-admin/update-username-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-the-username-for-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "Required. The user's new username.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The user's new username.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "thenewmonalisa"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "update-the-username-for-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The user's new username.
",
+ "name": "login",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The user's new username.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response",
+ "payload": "{\n \"message\": \"Job queued to rename user. It may take a few minutes to complete.\",\n \"url\": \"https://api.github.com/user/1\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/users/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/users/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /admin/users/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Delete a user",
+ "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.",
+ "operationId": "enterprise-admin/delete-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "delete-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.
\nYou can delete any user account except your own.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/admin/users/{username}/authorizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /admin/users/{username}/authorizations', {\n username: 'username',\n scopes: [\n 'scopes'\n ]\n})",
+ "html": "await octokit.request('POST /admin/users/{username}/authorizations', {\n username: 'username',\n scopes: [\n 'scopes'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Create an impersonation OAuth token",
+ "description": "",
+ "operationId": "enterprise-admin/create-impersonation-o-auth-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-an-impersonation-oauth-token"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "type": "array of strings",
+ "description": "A list of scopes.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "create-an-impersonation-oauth-token",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "A list of scopes.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of [scopes](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"abcdefgh12345678\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/admin/users/{username}/authorizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/admin/users/USERNAME/authorizations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /admin/users/{username}/authorizations', {\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /admin/users/{username}/authorizations', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Delete an impersonation OAuth token",
+ "description": "",
+ "operationId": "enterprise-admin/delete-impersonation-o-auth-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "delete-an-impersonation-oauth-token",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/app",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /app', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /app', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get the authenticated app",
+ "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@2.19/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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\" endpoint.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/app-manifests/{code}/conversions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "code",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/app-manifests/CODE/conversions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /app-manifests/{code}/conversions', {\n code: 'code'\n})",
+ "html": "await octokit.request('POST /app-manifests/{code}/conversions', {\n code: 'code'\n})\n
"
+ }
+ ],
+ "summary": "Create a GitHub App from a manifest",
+ "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-from-manifest",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#create-a-github-app-from-a-manifest"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "apps",
+ "subcategory": null
+ },
+ "slug": "create-a-github-app-from-a-manifest",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDxOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"client_id\": \"Iv1.8a61f9b3a7aba766\",\n \"client_secret\": \"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\n \"webhook_secret\": \"e340154128314309424b7c8e90325147d99fdafa\",\n \"pem\": \"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/app/installations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /app/installations', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /app/installations', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List installations for the authenticated app",
+ "description": "You must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#list-installations-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "list-installations-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"account\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"single_file_name\": \"config.yaml\",\n \"repository_selection\": \"selected\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app_slug\": \"github-actions\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/app/installations/{installation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /app/installations/{installation_id}', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /app/installations/{installation_id}', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get an installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-an-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-an-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"account\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"single_file_name\": \"config.yaml\",\n \"repository_selection\": \"selected\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app_slug\": \"github-actions\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/app/installations/{installation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n https://api.github.com/app/installations/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.gambit-preview+json\" \\\n https://api.github.com/app/installations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /app/installations/{installation_id}', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'gambit',\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /app/installations/{installation_id}', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'gambit',\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete an installation for the authenticated app",
+ "description": "Uninstalls a GitHub App on a user, organization, or business account. You must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/delete-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#delete-an-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "gambit",
+ "note": "Uninstalling GitHub Apps and revoking an app's installation token are currently available for developers to preview. To access the new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.gambit-preview+json\n```",
+ "html": "Uninstalling GitHub Apps and revoking an app's installation token are currently available for developers to preview. To access the new endpoint during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.gambit-preview+json
"
+ },
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "delete-an-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or business account. You must use a JWT to access this endpoint.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/app/installations/{installation_id}/access_tokens",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/app/installations/42/access_tokens \\\n -d '{\"repositories\":[\"repositories\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /app/installations/{installation_id}/access_tokens', {\n installation_id: 42,\n repositories: [\n 'repositories'\n ],\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('POST /app/installations/{installation_id}/access_tokens', {\n installation_id: 42,\n repositories: [\n 'repositories'\n ],\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create an installation access token for an app",
+ "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-installation-access-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#create-an-installation-access-token-for-an-app"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repositories": {
+ "description": "List of repository names that the token should have access to
",
+ "type": "array of strings",
+ "items": {
+ "type": "string",
+ "example": "rails"
+ },
+ "name": "repositories",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List of repository names that the token should have access to",
+ "childParamsGroups": []
+ },
+ "repository_ids": {
+ "description": "List of repository IDs that the token should have access to
",
+ "example": [
+ 1
+ ],
+ "type": "array of integers",
+ "items": {
+ "type": "integer"
+ },
+ "name": "repository_ids",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List of repository IDs that the token should have access to",
+ "childParamsGroups": []
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "contents": {
+ "type": "string",
+ "name": "contents",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "issues": {
+ "type": "string",
+ "name": "issues",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "deployments": {
+ "type": "string",
+ "name": "deployments",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "single_file": {
+ "type": "string",
+ "name": "single_file",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "def_not_a_repo": {
+ "type": "string",
+ "example": "\"read\"",
+ "name": "def_not_a_repo",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "example": {
+ "contents": "read",
+ "issues": "read",
+ "deployments": "write",
+ "single_file": "read"
+ },
+ "name": "permissions",
+ "in": "body",
+ "rawType": "object",
+ "description": "undefined
",
+ "childParamsGroups": [
+ {
+ "parentName": "permissions",
+ "parentType": "object",
+ "id": "permissions-object",
+ "params": [
+ {
+ "type": "string",
+ "name": "contents",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "name": "issues",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "name": "deployments",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "name": "single_file",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"read\"",
+ "name": "def_not_a_repo",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "create-an-installation-access-token-for-an-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "descriptionHTML": "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.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"token\": \"v1.1f699f1069f60xxx\",\n \"expires_at\": \"2016-07-11T22:14:10Z\",\n \"permissions\": {\n \"issues\": \"write\",\n \"contents\": \"read\"\n },\n \"repository_selection\": \"selected\",\n \"repositories\": [\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "description": "List of repository names that the token should have access to
",
+ "type": "array of strings",
+ "items": {
+ "type": "string",
+ "example": "rails"
+ },
+ "name": "repositories",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List of repository names that the token should have access to",
+ "childParamsGroups": []
+ },
+ {
+ "description": "List of repository IDs that the token should have access to
",
+ "example": [
+ 1
+ ],
+ "type": "array of integers",
+ "items": {
+ "type": "integer"
+ },
+ "name": "repository_ids",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List of repository IDs that the token should have access to",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "properties": {
+ "contents": {
+ "type": "string",
+ "name": "contents",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "issues": {
+ "type": "string",
+ "name": "issues",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "deployments": {
+ "type": "string",
+ "name": "deployments",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "single_file": {
+ "type": "string",
+ "name": "single_file",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "def_not_a_repo": {
+ "type": "string",
+ "example": "\"read\"",
+ "name": "def_not_a_repo",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "example": {
+ "contents": "read",
+ "issues": "read",
+ "deployments": "write",
+ "single_file": "read"
+ },
+ "name": "permissions",
+ "in": "body",
+ "rawType": "object",
+ "description": "undefined
",
+ "childParamsGroups": [
+ {
+ "parentName": "permissions",
+ "parentType": "object",
+ "id": "permissions-object",
+ "params": [
+ {
+ "type": "string",
+ "name": "contents",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "name": "issues",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "name": "deployments",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "name": "single_file",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"read\"",
+ "name": "def_not_a_repo",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/applications/grants",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /applications/grants')",
+ "html": "await octokit.request('GET /applications/grants')\n
"
+ }
+ ],
+ "summary": "List your grants",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/list-grants",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#list-your-grants"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "list-your-grants",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations 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. 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\"].
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"url\": \"https://api.github.com/applications/grants/1\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"scopes\": [\n \"public_repo\"\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/applications/grants/{grant_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "grant_id",
+ "description": "grant_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "grant_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /applications/grants/{grant_id}', {\n grant_id: 42\n})",
+ "html": "await octokit.request('GET /applications/grants/{grant_id}', {\n grant_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a single grant",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-grant",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-a-single-grant"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "get-a-single-grant",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/applications/grants/1\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"scopes\": [\n \"public_repo\"\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/applications/grants/{grant_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "grant_id",
+ "description": "grant_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "grant_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/grants/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /applications/grants/{grant_id}', {\n grant_id: 42\n})",
+ "html": "await octokit.request('DELETE /applications/grants/{grant_id}', {\n grant_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a grant",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/delete-grant",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#delete-a-grant"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "delete-a-grant",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/applications/{client_id}/grants/{access_token}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/grants/ACCESS_TOKEN
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /applications/{client_id}/grants/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
+ "html": "await octokit.request('DELETE /applications/{client_id}/grants/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})\n
"
+ }
+ ],
+ "summary": "Revoke a grant for an application",
+ "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "operationId": "oauth-authorizations/revoke-grant-for-application",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#revoke-a-grant-for-an-application"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "slug": "revoke-a-grant-for-an-application",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication for this method, where the username is the OAuth application client_id and the password is its client_secret. You must also provide a valid token as :access_token and the grant for the token's owner will be deleted.
\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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/applications/{client_id}/tokens/{access_token}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
+ "html": "await octokit.request('GET /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})\n
"
+ }
+ ],
+ "summary": "Check an authorization",
+ "description": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "operationId": "oauth-authorizations/check-authorization",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#check-an-authorization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "slug": "check-an-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication when accessing it, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"abcdefgh12345678\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/applications/{client_id}/tokens/{access_token}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
+ "html": "await octokit.request('POST /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})\n
"
+ }
+ ],
+ "summary": "Reset an authorization",
+ "description": "OAuth applications can use this API method to reset a valid OAuth token without end user involvement. Applications must save the \"token\" property in the response, because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "operationId": "oauth-authorizations/reset-authorization",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#reset-an-authorization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "slug": "reset-an-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 when accessing it, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"abcdefgh12345678\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/applications/{client_id}/tokens/{access_token}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/applications/CLIENT_ID/tokens/ACCESS_TOKEN
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})",
+ "html": "await octokit.request('DELETE /applications/{client_id}/tokens/{access_token}', {\n client_id: 'client_id',\n access_token: 'access_token'\n})\n
"
+ }
+ ],
+ "summary": "Revoke an authorization for an application",
+ "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`.",
+ "operationId": "oauth-authorizations/revoke-authorization-for-application",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#revoke-an-authorization-for-an-application"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "slug": "revoke-an-authorization-for-an-application",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication for this method, where the username is the OAuth application client_id and the password is its client_secret.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/apps/{app_slug}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "app_slug",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/apps/APP_SLUG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /apps/{app_slug}', {\n app_slug: 'app_slug',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /apps/{app_slug}', {\n app_slug: 'app_slug',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get an app",
+ "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-by-slug",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-an-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-an-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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).
\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 or an installation access token to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/authorizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /authorizations')",
+ "html": "await octokit.request('GET /authorizations')\n
"
+ }
+ ],
+ "summary": "List your authorizations",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/list-authorizations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#list-your-authorizations"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "list-your-authorizations",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 2,\n \"url\": \"https://enterprise.octocat.com/api/v3/authorizations/2\",\n \"app\": {\n \"name\": \"My personal access token\",\n \"url\": \"https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens\",\n \"client_id\": \"00000000000000000000\"\n },\n \"token\": \"\",\n \"hashed_token\": \"23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45\",\n \"token_last_eight\": \"848f9f8a\",\n \"note\": \"My personal access token\",\n \"note_url\": null,\n \"created_at\": \"2019-04-24T21:49:02Z\",\n \"updated_at\": \"2019-04-24T21:49:02Z\",\n \"scopes\": [\n \"admin:business\",\n \"admin:gpg_key\",\n \"admin:org\",\n \"admin:org_hook\",\n \"admin:pre_receive_hook\",\n \"admin:public_key\",\n \"admin:repo_hook\",\n \"delete_repo\",\n \"gist\",\n \"notifications\",\n \"repo\",\n \"user\",\n \"write:discussion\"\n ],\n \"fingerprint\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/authorizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations \\\n -d '{\"scopes\":[\"scopes\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /authorizations', {\n scopes: [\n 'scopes'\n ]\n})",
+ "html": "await octokit.request('POST /authorizations', {\n scopes: [\n 'scopes'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Create a new authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/create-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "client_id": {
+ "description": "The OAuth app client key for which to create the token.
",
+ "maxLength": 20,
+ "type": "string",
+ "name": "client_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client key for which to create the token.",
+ "childParamsGroups": []
+ },
+ "client_secret": {
+ "description": "The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "create-a-new-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using 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.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
\nYou can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The OAuth app client key for which to create the token.
",
+ "maxLength": 20,
+ "type": "string",
+ "name": "client_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client key for which to create the token.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"abcdefgh12345678\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/authorizations/clients/{client_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID \\\n -d '{\"client_secret\":\"client_secret\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /authorizations/clients/{client_id}', {\n client_id: 'client_id',\n client_secret: 'client_secret'\n})",
+ "html": "await octokit.request('PUT /authorizations/clients/{client_id}', {\n client_id: 'client_id',\n client_secret: 'client_secret'\n})\n
"
+ }
+ ],
+ "summary": "Get-or-create an authorization for a specific app",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-or-create-authorization-for-app",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "client_secret": {
+ "description": "Required. The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "client_secret"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "get-or-create-an-authorization-for-a-specific-app",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nDeprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
",
+ "bodyParameters": [
+ {
+ "description": "Required. The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if returning an existing token",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"abcdefgh12345678\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/authorizations/clients/{client_id}/{fingerprint}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "fingerprint",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/clients/CLIENT_ID/FINGERPRINT \\\n -d '{\"client_secret\":\"client_secret\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /authorizations/clients/{client_id}/{fingerprint}', {\n client_id: 'client_id',\n fingerprint: 'fingerprint',\n client_secret: 'client_secret'\n})",
+ "html": "await octokit.request('PUT /authorizations/clients/{client_id}/{fingerprint}', {\n client_id: 'client_id',\n fingerprint: 'fingerprint',\n client_secret: 'client_secret'\n})\n
"
+ }
+ ],
+ "summary": "Get-or-create an authorization for a specific app and fingerprint",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "client_secret": {
+ "description": "Required. The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "client_secret"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "get-or-create-an-authorization-for-a-specific-app-and-fingerprint",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
",
+ "bodyParameters": [
+ {
+ "description": "Required. The OAuth app client secret for which to create the token.
",
+ "maxLength": 40,
+ "type": "string",
+ "name": "client_secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The OAuth app client secret for which to create the token.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if returning an existing token",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"abcdefgh12345678\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/authorizations/{authorization_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "authorization_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /authorizations/{authorization_id}', {\n authorization_id: 42\n})",
+ "html": "await octokit.request('GET /authorizations/{authorization_id}', {\n authorization_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a single authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-a-single-authorization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "get-a-single-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/authorizations/{authorization_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "authorization_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42 \\\n -d '{\"scopes\":[\"scopes\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /authorizations/{authorization_id}', {\n authorization_id: 42,\n scopes: [\n 'scopes'\n ]\n})",
+ "html": "await octokit.request('PATCH /authorizations/{authorization_id}', {\n authorization_id: 42,\n scopes: [\n 'scopes'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Update an existing authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/update-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#update-an-existing-authorization"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ "add_scopes": {
+ "description": "A list of scopes to add to this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to add to this authorization.",
+ "childParamsGroups": []
+ },
+ "remove_scopes": {
+ "description": "A list of scopes to remove from this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to remove from this authorization.",
+ "childParamsGroups": []
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "update-an-existing-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
",
+ "bodyParameters": [
+ {
+ "description": "A list of scopes that this authorization is in.
",
+ "type": "array of strings or null",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true,
+ "name": "scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes that this authorization is in.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A list of scopes to add to this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to add to this authorization.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A list of scopes to remove from this authorization.
",
+ "type": "array of strings",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_scopes",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "A list of scopes to remove from this authorization.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A note to remind you what the OAuth token is for.
",
+ "type": "string",
+ "example": "Update all gems",
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A note to remind you what the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL to remind you what app the OAuth token is for.
",
+ "type": "string",
+ "name": "note_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL to remind you what app the OAuth token is for.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
",
+ "type": "string",
+ "name": "fingerprint",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"\",\n \"token_last_eight\": \"12345678\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/authorizations/{authorization_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "authorization_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/authorizations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /authorizations/{authorization_id}', {\n authorization_id: 42\n})",
+ "html": "await octokit.request('DELETE /authorizations/{authorization_id}', {\n authorization_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete an authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/delete-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#delete-an-authorization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true,
+ "slug": "delete-an-authorization",
+ "category": "oauth-authorizations",
+ "categoryLabel": "Oauth authorizations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, 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. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/codes_of_conduct",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /codes_of_conduct', {\n mediaType: {\n previews: [\n 'scarlet-witch'\n ]\n }\n})",
+ "html": "await octokit.request('GET /codes_of_conduct', {\n mediaType: {\n previews: [\n 'scarlet-witch'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get all codes of conduct",
+ "description": "",
+ "tags": [
+ "codes-of-conduct"
+ ],
+ "operationId": "codes-of-conduct/get-all-codes-of-conduct",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/codes_of_conduct/#get-all-codes-of-conduct"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```",
+ "html": "The Codes of Conduct API is currently available for developers to preview.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.scarlet-witch-preview+json
"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ },
+ "slug": "get-all-codes-of-conduct",
+ "category": "codes-of-conduct",
+ "categoryLabel": "Codes of conduct",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"citizen_code_of_conduct\",\n \"name\": \"Citizen Code of Conduct\",\n \"url\": \"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\",\n \"html_url\": \"http://citizencodeofconduct.org/\"\n },\n {\n \"key\": \"contributor_covenant\",\n \"name\": \"Contributor Covenant\",\n \"url\": \"https://api.github.com/codes_of_conduct/contributor_covenant\",\n \"html_url\": \"https://www.contributor-covenant.org/version/2/0/code_of_conduct/\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/codes_of_conduct/{key}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/codes_of_conduct/KEY
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /codes_of_conduct/{key}', {\n key: 'key',\n mediaType: {\n previews: [\n 'scarlet-witch'\n ]\n }\n})",
+ "html": "await octokit.request('GET /codes_of_conduct/{key}', {\n key: 'key',\n mediaType: {\n previews: [\n 'scarlet-witch'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a code of conduct",
+ "description": "",
+ "tags": [
+ "codes-of-conduct"
+ ],
+ "operationId": "codes-of-conduct/get-conduct-code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/codes_of_conduct/#get-a-code-of-conduct"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```",
+ "html": "The Codes of Conduct API is currently available for developers to preview.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.scarlet-witch-preview+json
"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ },
+ "slug": "get-a-code-of-conduct",
+ "category": "codes-of-conduct",
+ "categoryLabel": "Codes of conduct",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"key\": \"contributor_covenant\",\n \"name\": \"Contributor Covenant\",\n \"url\": \"https://api.github.com/codes_of_conduct/contributor_covenant\",\n \"body\": \"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\n \"html_url\": \"http://contributor-covenant.org/version/1/4/\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/content_references/{content_reference_id}/attachments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "content_reference_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /content_references/{content_reference_id}/attachments', {\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})",
+ "html": "await octokit.request('POST /content_references/{content_reference_id}/attachments', {\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a content attachment",
+ "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-content-attachment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "Required. The title of the attachment
",
+ "example": "Title of the attachment",
+ "type": "string",
+ "maxLength": 1024,
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the attachment",
+ "childParamsGroups": []
+ },
+ "body": {
+ "description": "Required. The body of the attachment
",
+ "example": "Body of the attachment",
+ "type": "string",
+ "maxLength": 262144,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body of the attachment",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "corsair",
+ "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```",
+ "html": "To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.corsair-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "create-a-content-attachment",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "descriptionHTML": "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 to create an attachment.
\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.
\nYou must use an installation access token to access this endpoint.
",
+ "bodyParameters": [
+ {
+ "description": "Required. The title of the attachment
",
+ "example": "Title of the attachment",
+ "type": "string",
+ "maxLength": 1024,
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the attachment",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Required. The body of the attachment
",
+ "example": "Body of the attachment",
+ "type": "string",
+ "maxLength": 262144,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body of the attachment",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 101,\n \"title\": \"[A-1234] Error found in core/models.py file'\",\n \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/emojis",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/emojis
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /emojis')",
+ "html": "await octokit.request('GET /emojis')\n
"
+ }
+ ],
+ "summary": "Get emojis",
+ "description": "Lists all the emojis available to use on GitHub Enterprise Server.",
+ "operationId": "emojis/get",
+ "tags": [
+ "emojis"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/emojis/#get-emojis"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "emojis",
+ "subcategory": null
+ },
+ "slug": "get-emojis",
+ "category": "emojis",
+ "categoryLabel": "Emojis",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all the emojis available to use on GitHub Enterprise Server.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/enterprise/settings/license",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/settings/license
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /enterprise/settings/license')",
+ "html": "await octokit.request('GET /enterprise/settings/license')\n
"
+ }
+ ],
+ "summary": "Get license information",
+ "description": "",
+ "operationId": "enterprise-admin/get-license-information",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-license-information"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "license"
+ },
+ "slug": "get-license-information",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "license",
+ "subcategoryLabel": "License",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"seats\": 1400,\n \"seats_used\": 1316,\n \"seats_available\": 84,\n \"kind\": \"standard\",\n \"days_until_expiration\": 365,\n \"expire_at\": \"2016/02/06 12:41:52 -0600\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/enterprise/stats/{type}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprise/stats/TYPE
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /enterprise/stats/{type}', {\n type: 'type'\n})",
+ "html": "await octokit.request('GET /enterprise/stats/{type}', {\n type: 'type'\n})\n
"
+ }
+ ],
+ "summary": "Get statistics",
+ "description": "There are a variety of types to choose from:\n\n| Type | Description |\n| ------------ | --------------------------------------------------------------------------------------------------- |\n| `issues` | The number of open and closed issues. |\n| `hooks` | The number of active and inactive hooks. |\n| `milestones` | The number of open and closed milestones. |\n| `orgs` | The number of organizations, teams, team members, and disabled organizations. |\n| `comments` | The number of comments on issues, pull requests, commits, and gists. |\n| `pages` | The number of GitHub Pages sites. |\n| `users` | The number of suspended and admin users. |\n| `gists` | The number of private and public gists. |\n| `pulls` | The number of merged, mergeable, and unmergeable pull requests. |\n| `repos` | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis. |\n| `all` | All of the statistics listed above. |\n\nThese statistics are cached and will be updated approximately every 10 minutes.",
+ "operationId": "enterprise-admin/get-type-stats",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-statistics"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "admin-stats"
+ },
+ "slug": "get-statistics",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "admin-stats",
+ "subcategoryLabel": "Admin stats",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "There are a variety of types to choose from:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|
issues | The number of open and closed issues. |
hooks | The number of active and inactive hooks. |
milestones | The number of open and closed milestones. |
orgs | The number of organizations, teams, team members, and disabled organizations. |
comments | The number of comments on issues, pull requests, commits, and gists. |
pages | The number of GitHub Pages sites. |
users | The number of suspended and admin users. |
gists | The number of private and public gists. |
pulls | The number of merged, mergeable, and unmergeable pull requests. |
repos | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis. |
all | All of the statistics listed above. |
\nThese statistics are cached and will be updated approximately every 10 minutes.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"repos\": {\n \"total_repos\": 212,\n \"root_repos\": 194,\n \"fork_repos\": 18,\n \"org_repos\": 51,\n \"total_pushes\": 3082,\n \"total_wikis\": 15\n },\n \"hooks\": {\n \"total_hooks\": 27,\n \"active_hooks\": 23,\n \"inactive_hooks\": 4\n },\n \"pages\": {\n \"total_pages\": 36\n },\n \"orgs\": {\n \"total_orgs\": 33,\n \"disabled_orgs\": 0,\n \"total_teams\": 60,\n \"total_team_members\": 314\n },\n \"users\": {\n \"total_users\": 254,\n \"admin_users\": 45,\n \"suspended_users\": 21\n },\n \"pulls\": {\n \"total_pulls\": 86,\n \"merged_pulls\": 60,\n \"mergeable_pulls\": 21,\n \"unmergeable_pulls\": 3\n },\n \"issues\": {\n \"total_issues\": 179,\n \"open_issues\": 83,\n \"closed_issues\": 96\n },\n \"milestones\": {\n \"total_milestones\": 7,\n \"open_milestones\": 6,\n \"closed_milestones\": 1\n },\n \"gists\": {\n \"total_gists\": 178,\n \"private_gists\": 151,\n \"public_gists\": 25\n },\n \"comments\": {\n \"total_commit_comments\": 6,\n \"total_gist_comments\": 28,\n \"total_issue_comments\": 366,\n \"total_pull_request_comments\": 30\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /events')",
+ "html": "await octokit.request('GET /events')\n
"
+ }
+ ],
+ "summary": "List public events",
+ "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-public-events"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-events",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/feeds",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /feeds')",
+ "html": "await octokit.request('GET /feeds')\n
"
+ }
+ ],
+ "summary": "Get feeds",
+ "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@2.19/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 Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-feeds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#get-feeds"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "feeds"
+ },
+ "slug": "get-feeds",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "feeds",
+ "subcategoryLabel": "Feeds",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\n\n- Timeline: The GitHub Enterprise Server global public timeline
\n- User: The public timeline for any user, using URI template
\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 Enterprise Server.
\n
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"timeline_url\": \"https://github.com/timeline\",\n \"user_url\": \"https://github.com/{user}\",\n \"current_user_public_url\": \"https://github.com/octocat\",\n \"current_user_url\": \"https://github.com/octocat.private?token=abc123\",\n \"current_user_actor_url\": \"https://github.com/octocat.private.actor?token=abc123\",\n \"current_user_organization_url\": \"\",\n \"current_user_organization_urls\": [\n \"https://github.com/organizations/github/octocat.private.atom?token=abc123\"\n ],\n \"_links\": [\n {\n \"timeline\": {\n \"href\": \"https://github.com/timeline\",\n \"type\": \"application/atom+xml\"\n },\n \"user\": {\n \"href\": \"https://github.com/{user}\",\n \"type\": \"application/atom+xml\"\n },\n \"current_user_public\": {\n \"href\": \"https://github.com/octocat\",\n \"type\": \"application/atom+xml\"\n },\n \"current_user\": {\n \"href\": \"https://github.com/octocat.private?token=abc123\",\n \"type\": \"application/atom+xml\"\n },\n \"current_user_actor\": {\n \"href\": \"https://github.com/octocat.private.actor?token=abc123\",\n \"type\": \"application/atom+xml\"\n },\n \"current_user_organization\": {\n \"href\": \"\",\n \"type\": \"\"\n },\n \"current_user_organizations\": [\n {\n \"href\": \"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\n \"type\": \"application/atom+xml\"\n }\n ]\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists')",
+ "html": "await octokit.request('GET /gists')\n
"
+ }
+ ],
+ "summary": "List gists for the authenticated user",
+ "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-gists-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-gists-for-the-authenticated-user",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"files\": {\n \"hello_world.rb\": {\n \"filename\": \"hello_world.rb\",\n \"type\": \"application/x-ruby\",\n \"language\": \"Ruby\",\n \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n \"size\": 167\n }\n },\n \"public\": true,\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"user\": null,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"truncated\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/gists",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /gists', {\n files: {}\n})",
+ "html": "await octokit.request('POST /gists', {\n files: {}\n})\n
"
+ }
+ ],
+ "summary": "Create a gist",
+ "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.",
+ "operationId": "gists/create",
+ "tags": [
+ "gists"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#create-a-gist"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "description": {
+ "description": "Description of the gist
",
+ "example": "Example Ruby script",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Description of the gist",
+ "childParamsGroups": []
+ },
+ "files": {
+ "description": "Required. 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"
+ ]
+ },
+ "name": "files",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Names and content for the files that make up the gist",
+ "childParamsGroups": []
+ },
+ "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"
+ ]
+ }
+ ],
+ "name": "public",
+ "in": "body",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "files"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "create-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote: Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "description": "Description of the gist
",
+ "example": "Example Ruby script",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Description of the gist",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Required. 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"
+ ]
+ },
+ "name": "files",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Names and content for the files that make up the gist",
+ "childParamsGroups": []
+ },
+ {
+ "oneOf": [
+ {
+ "description": "Flag indicating whether the gist is public",
+ "example": true,
+ "type": "boolean",
+ "default": false
+ },
+ {
+ "type": "string",
+ "example": "true",
+ "default": "false",
+ "enum": [
+ "true",
+ "false"
+ ]
+ }
+ ],
+ "name": "public",
+ "in": "body",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/public",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/public')",
+ "html": "await octokit.request('GET /gists/public')\n
"
+ }
+ ],
+ "summary": "List public gists",
+ "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-public-gists"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-public-gists",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List public gists sorted by most recently updated to least recently updated.
\nNote: With 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"files\": {\n \"hello_world.rb\": {\n \"filename\": \"hello_world.rb\",\n \"type\": \"application/x-ruby\",\n \"language\": \"Ruby\",\n \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n \"size\": 167\n }\n },\n \"public\": true,\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"user\": null,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"truncated\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/starred",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/starred')",
+ "html": "await octokit.request('GET /gists/starred')\n
"
+ }
+ ],
+ "summary": "List starred gists",
+ "description": "List the authenticated user's starred gists:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-starred-gists"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-starred-gists",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the authenticated user's starred gists:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"files\": {\n \"hello_world.rb\": {\n \"filename\": \"hello_world.rb\",\n \"type\": \"application/x-ruby\",\n \"language\": \"Ruby\",\n \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n \"size\": 167\n }\n },\n \"public\": true,\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"user\": null,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"truncated\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "Get a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#get-a-gist"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "get-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden gist"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/gists/{gist_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /gists/{gist_id}', {\n gist_id: 'gist_id',\n description: 'description'\n})",
+ "html": "await octokit.request('PATCH /gists/{gist_id}', {\n gist_id: 'gist_id',\n description: 'description'\n})\n
"
+ }
+ ],
+ "summary": "Update a gist",
+ "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#update-a-gist"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "description": {
+ "description": "Description of the gist
",
+ "example": "Example Ruby script",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Description of the gist",
+ "childParamsGroups": []
+ },
+ "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
+ },
+ "name": "files",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Names of files to be updated",
+ "childParamsGroups": []
+ }
+ },
+ "anyOf": [
+ {
+ "required": [
+ "description"
+ ]
+ },
+ {
+ "required": [
+ "files"
+ ]
+ }
+ ],
+ "type": "object",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "update-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "description": "Description of the gist
",
+ "example": "Example Ruby script",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Description of the gist",
+ "childParamsGroups": []
+ },
+ {
+ "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
+ },
+ "name": "files",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Names of files to be updated",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/gists/{gist_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /gists/{gist_id}', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('DELETE /gists/{gist_id}', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "Delete a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#delete-a-gist"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "delete-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}/comments', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}/comments', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "List gist comments",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/gists#list-gist-comments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": "comments"
+ },
+ "slug": "list-gist-comments",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n \"body\": \"Just commenting for the sake of commenting\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-18T23:23:56Z\",\n \"updated_at\": \"2011-04-18T23:23:56Z\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/gists/{gist_id}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /gists/{gist_id}/comments', {\n gist_id: 'gist_id',\n body: 'body'\n})",
+ "html": "await octokit.request('POST /gists/{gist_id}/comments', {\n gist_id: 'gist_id',\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a gist comment",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/create-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/gists#create-a-gist-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "body": {
+ "description": "Required. The comment text.
",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The comment text.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": "comments"
+ },
+ "slug": "create-a-gist-comment",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. The comment text.
",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The comment text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n \"body\": \"Just commenting for the sake of commenting\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-18T23:23:56Z\",\n \"updated_at\": \"2011-04-18T23:23:56Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a gist comment",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/gists#get-a-gist-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": "comments"
+ },
+ "slug": "get-a-gist-comment",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n \"body\": \"Just commenting for the sake of commenting\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-18T23:23:56Z\",\n \"updated_at\": \"2011-04-18T23:23:56Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden gist"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/gists/{gist_id}/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update a gist comment",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/update-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/gists#update-a-gist-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "body": {
+ "description": "Required. The comment text.
",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The comment text.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "body"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": "comments"
+ },
+ "slug": "update-a-gist-comment",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. The comment text.
",
+ "type": "string",
+ "maxLength": 65535,
+ "example": "Body of the attachment",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The comment text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n \"body\": \"Just commenting for the sake of commenting\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-18T23:23:56Z\",\n \"updated_at\": \"2011-04-18T23:23:56Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/gists/{gist_id}/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})",
+ "html": "await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a gist comment",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/delete-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/gists#delete-a-gist-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": "comments"
+ },
+ "slug": "delete-a-gist-comment",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}/commits', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}/commits', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "List gist commits",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-gist-commits"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-gist-commits",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n \"version\": \"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"change_status\": {\n \"deletions\": 0,\n \"additions\": 180,\n \"total\": 180\n },\n \"committed_at\": \"2010-04-14T02:15:15Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}/forks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "List gist forks",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-gist-forks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-gist-forks",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/dee9c42e4998ce2ea439\",\n \"id\": \"dee9c42e4998ce2ea439\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/gists/{gist_id}/forks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('POST /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "Fork a gist",
+ "description": "**Note**: This was previously `/gists/:gist_id/fork`.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#fork-a-gist"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "fork-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: This was previously /gists/:gist_id/fork.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"files\": {\n \"hello_world.rb\": {\n \"filename\": \"hello_world.rb\",\n \"type\": \"application/x-ruby\",\n \"language\": \"Ruby\",\n \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n \"size\": 167\n }\n },\n \"public\": true,\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"user\": null,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"truncated\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}/star",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "Check if a gist is starred",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/check-is-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#check-if-a-gist-is-starred"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "check-if-a-gist-is-starred",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if gist is starred"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if gist is not starred"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/gists/{gist_id}/star",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('PUT /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "Star a gist",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/star",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#star-a-gist"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "star-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/gists/{gist_id}/star",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})",
+ "html": "await octokit.request('DELETE /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})\n
"
+ }
+ ],
+ "summary": "Unstar a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/unstar",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#unstar-a-gist"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "unstar-a-gist",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gists/{gist_id}/{sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "gist_id parameter
"
+ },
+ {
+ "name": "sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gists/{gist_id}/{sha}', {\n gist_id: 'gist_id',\n sha: 'sha'\n})",
+ "html": "await octokit.request('GET /gists/{gist_id}/{sha}', {\n gist_id: 'gist_id',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a gist revision",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get-revision",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#get-a-gist-revision"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "get-a-gist-revision",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gitignore/templates",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gitignore/templates')",
+ "html": "await octokit.request('GET /gitignore/templates')\n
"
+ }
+ ],
+ "summary": "Get all gitignore templates",
+ "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-for-the-authenticated-user).",
+ "operationId": "gitignore/get-all-templates",
+ "tags": [
+ "gitignore"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gitignore/#get-all-gitignore-templates"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "gitignore",
+ "subcategory": null
+ },
+ "slug": "get-all-gitignore-templates",
+ "category": "gitignore",
+ "categoryLabel": "Gitignore",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all templates available to pass as an option when creating a repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response",
+ "payload": "[\n \"Actionscript\",\n \"Android\",\n \"AppceleratorTitanium\",\n \"Autotools\",\n \"Bancha\",\n \"C\",\n \"C++\"\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/gitignore/templates/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /gitignore/templates/{name}', {\n name: 'name'\n})",
+ "html": "await octokit.request('GET /gitignore/templates/{name}', {\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Get a gitignore template",
+ "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/) to get the raw contents.",
+ "operationId": "gitignore/get-template",
+ "tags": [
+ "gitignore"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gitignore/#get-a-gitignore-template"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "gitignore",
+ "subcategory": null
+ },
+ "slug": "get-a-gitignore-template",
+ "category": "gitignore",
+ "categoryLabel": "Gitignore",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"name\": \"C\",\n \"source\": \"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/installation/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/installation/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /installation/repositories', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /installation/repositories', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List repositories accessible to the app installation",
+ "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-repos-accessible-to-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#list-repositories-accessible-to-the-app-installation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "list-repositories-accessible-to-the-app-installation",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"repositories\": [\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/issues",
+ "serverUrl": "https://api.github.com",
+ "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"
+ },
+ "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "collab",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "orgs",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owned",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pulls",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /issues')",
+ "html": "await octokit.request('GET /issues')\n
"
+ }
+ ],
+ "summary": "List issues assigned to the authenticated user",
+ "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#list-issues-assigned-to-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "list-issues-assigned-to-the-authenticated-user",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/licenses",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "featured",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /licenses')",
+ "html": "await octokit.request('GET /licenses')\n
"
+ }
+ ],
+ "summary": "Get all commonly used licenses",
+ "description": "",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-all-commonly-used",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/licenses/#get-all-commonly-used-licenses"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "licenses",
+ "subcategory": null
+ },
+ "slug": "get-all-commonly-used-licenses",
+ "category": "licenses",
+ "categoryLabel": "Licenses",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n {\n \"key\": \"lgpl-3.0\",\n \"name\": \"GNU Lesser General Public License v3.0\",\n \"spdx_id\": \"LGPL-3.0\",\n \"url\": \"https://api.github.com/licenses/lgpl-3.0\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n {\n \"key\": \"mpl-2.0\",\n \"name\": \"Mozilla Public License 2.0\",\n \"spdx_id\": \"MPL-2.0\",\n \"url\": \"https://api.github.com/licenses/mpl-2.0\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n {\n \"key\": \"agpl-3.0\",\n \"name\": \"GNU Affero General Public License v3.0\",\n \"spdx_id\": \"AGPL-3.0\",\n \"url\": \"https://api.github.com/licenses/agpl-3.0\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n {\n \"key\": \"unlicense\",\n \"name\": \"The Unlicense\",\n \"spdx_id\": \"Unlicense\",\n \"url\": \"https://api.github.com/licenses/unlicense\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n {\n \"key\": \"apache-2.0\",\n \"name\": \"Apache License 2.0\",\n \"spdx_id\": \"Apache-2.0\",\n \"url\": \"https://api.github.com/licenses/apache-2.0\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n {\n \"key\": \"gpl-3.0\",\n \"name\": \"GNU General Public License v3.0\",\n \"spdx_id\": \"GPL-3.0\",\n \"url\": \"https://api.github.com/licenses/gpl-3.0\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/licenses/{license}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "license",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /licenses/{license}', {\n license: 'license'\n})",
+ "html": "await octokit.request('GET /licenses/{license}', {\n license: 'license'\n})\n
"
+ }
+ ],
+ "summary": "Get a license",
+ "description": "",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/licenses/#get-a-license"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "licenses",
+ "subcategory": null
+ },
+ "slug": "get-a-license",
+ "category": "licenses",
+ "categoryLabel": "Licenses",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"http://choosealicense.com/licenses/mit/\",\n \"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.\",\n \"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.\",\n \"permissions\": [\n \"commercial-use\",\n \"modifications\",\n \"distribution\",\n \"sublicense\",\n \"private-use\"\n ],\n \"conditions\": [\n \"include-copyright\"\n ],\n \"limitations\": [\n \"no-liability\"\n ],\n \"body\": \"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\n \"featured\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/markdown",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /markdown', {\n text: 'text'\n})",
+ "html": "await octokit.request('POST /markdown', {\n text: 'text'\n})\n
"
+ }
+ ],
+ "summary": "Render a Markdown document",
+ "description": "",
+ "operationId": "markdown/render",
+ "tags": [
+ "markdown"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/markdown/#render-a-markdown-document"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "text": {
+ "description": "Required. The Markdown text to render in HTML.
",
+ "type": "string",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The Markdown text to render in HTML.",
+ "childParamsGroups": []
+ },
+ "mode": {
+ "description": "The rendering mode.
",
+ "enum": [
+ "markdown",
+ "gfm"
+ ],
+ "default": "markdown",
+ "example": "markdown",
+ "type": "string",
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The rendering mode.",
+ "childParamsGroups": []
+ },
+ "context": {
+ "description": "The repository context to use when creating references in gfm mode.
",
+ "type": "string",
+ "name": "context",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository context to use when creating references in `gfm` mode.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "text"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "markdown",
+ "subcategory": null
+ },
+ "slug": "render-a-markdown-document",
+ "category": "markdown",
+ "categoryLabel": "Markdown",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. The Markdown text to render in HTML.
",
+ "type": "string",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The Markdown text to render in HTML.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The rendering mode.
",
+ "enum": [
+ "markdown",
+ "gfm"
+ ],
+ "default": "markdown",
+ "example": "markdown",
+ "type": "string",
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The rendering mode.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The repository context to use when creating references in gfm mode.
",
+ "type": "string",
+ "name": "context",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository context to use when creating references in `gfm` mode.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/markdown/raw",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /markdown/raw')",
+ "html": "await octokit.request('POST /markdown/raw')\n
"
+ }
+ ],
+ "summary": "Render a Markdown document in raw mode",
+ "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.",
+ "operationId": "markdown/render-raw",
+ "tags": [
+ "markdown"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/markdown/#render-a-markdown-document-in-raw-mode"
+ },
+ "requestBody": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ },
+ "text/x-markdown": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "markdown",
+ "subcategory": null
+ },
+ "slug": "render-a-markdown-document-in-raw-mode",
+ "category": "markdown",
+ "categoryLabel": "Markdown",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/meta",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /meta')",
+ "html": "await octokit.request('GET /meta')\n
"
+ }
+ ],
+ "summary": "Get GitHub Enterprise Server 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://docs.github.com/enterprise-server@2.19/v3/meta/#get-github-meta-information"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "meta",
+ "subcategory": null
+ },
+ "slug": "get-github-enterprise-server-meta-information",
+ "category": "meta",
+ "categoryLabel": "Meta",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"verifiable_password_authentication\": true,\n \"installed_version\": \"2.19.0\",\n \"github_services_sha\": \"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/networks/{owner}/{repo}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /networks/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /networks/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List public events for a network of repositories",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events-for-repo-network",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-public-events-for-a-network-of-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-events-for-a-network-of-repositories",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/notifications",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "all",
+ "description": "If `true`, show notifications marked as read.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ },
+ "descriptionHTML": "If true, show notifications marked as read.
"
+ },
+ {
+ "name": "participating",
+ "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ },
+ "descriptionHTML": "If true, only shows notifications in which the user is directly participating or mentioned.
"
+ },
+ {
+ "name": "since",
+ "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "before",
+ "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /notifications')",
+ "html": "await octokit.request('GET /notifications')\n
"
+ }
+ ],
+ "summary": "List notifications for the authenticated user",
+ "description": "List all notifications for the current user, sorted by most recently updated.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-notifications-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-notifications-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "list-notifications-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all notifications for the current user, sorted by most recently updated.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": \"1\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"subject\": {\n \"title\": \"Greetings\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n \"type\": \"Issue\"\n },\n \"reason\": \"subscribed\",\n \"unread\": true,\n \"updated_at\": \"2014-11-07T22:01:45Z\",\n \"last_read_at\": \"2014-11-07T22:01:45Z\",\n \"url\": \"https://api.github.com/notifications/threads/1\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/notifications",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /notifications', {\n last_read_at: 'last_read_at'\n})",
+ "html": "await octokit.request('PUT /notifications', {\n last_read_at: 'last_read_at'\n})\n
"
+ }
+ ],
+ "summary": "Mark notifications as read",
+ "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](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 Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#mark-notifications-as-read"
+ },
+ "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",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Describes the last point that notifications were checked.",
+ "childParamsGroups": []
+ },
+ "read": {
+ "description": "Whether the notification has been read.
",
+ "type": "boolean",
+ "name": "read",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the notification has been read.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "mark-notifications-as-read",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "205",
+ "httpStatusMessage": "Reset Content",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "descriptionHTML": "Marks all notifications as \"read\" removes it from the default view on GitHub Enterprise Server. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server 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 endpoint and pass the query parameter all=false.
",
+ "bodyParameters": [
+ {
+ "description": "Describes the last point that notifications were checked.
",
+ "type": "string",
+ "format": "date-time",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Describes the last point that notifications were checked.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the notification has been read.
",
+ "type": "boolean",
+ "name": "read",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the notification has been read.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/notifications/threads/{thread_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "thread_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /notifications/threads/{thread_id}', {\n thread_id: 42\n})",
+ "html": "await octokit.request('GET /notifications/threads/{thread_id}', {\n thread_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a thread",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-thread",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#get-a-thread"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "get-a-thread",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": \"1\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"subject\": {\n \"title\": \"Greetings\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n \"type\": \"Issue\"\n },\n \"reason\": \"subscribed\",\n \"unread\": true,\n \"updated_at\": \"2014-11-07T22:01:45Z\",\n \"last_read_at\": \"2014-11-07T22:01:45Z\",\n \"url\": \"https://api.github.com/notifications/threads/1\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/notifications/threads/{thread_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "thread_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /notifications/threads/{thread_id}', {\n thread_id: 42\n})",
+ "html": "await octokit.request('PATCH /notifications/threads/{thread_id}', {\n thread_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Mark a thread as read",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-thread-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#mark-a-thread-as-read"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "mark-a-thread-as-read",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "205",
+ "httpStatusMessage": "Reset Content",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/notifications/threads/{thread_id}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "thread_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})",
+ "html": "await octokit.request('GET /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a thread subscription for the authenticated user",
+ "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-thread-subscription-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "get-a-thread-subscription-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.
\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"subscribed\": true,\n \"ignored\": false,\n \"reason\": null,\n \"created_at\": \"2012-10-06T21:34:12Z\",\n \"url\": \"https://api.github.com/notifications/threads/1/subscription\",\n \"thread_url\": \"https://api.github.com/notifications/threads/1\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/notifications/threads/{thread_id}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "thread_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {\n thread_id: 42,\n ignored: true\n})",
+ "html": "await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {\n thread_id: 42,\n ignored: true\n})\n
"
+ }
+ ],
+ "summary": "Set a thread subscription",
+ "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#delete-a-thread-subscription) endpoint.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-thread-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#set-a-thread-subscription"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "ignored": {
+ "description": "Whether to block all notifications from a thread.
",
+ "default": false,
+ "type": "boolean",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to block all notifications from a thread.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "set-a-thread-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "descriptionHTML": "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.
\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.
\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.
",
+ "bodyParameters": [
+ {
+ "description": "Whether to block all notifications from a thread.
",
+ "default": false,
+ "type": "boolean",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to block all notifications from a thread.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"subscribed\": true,\n \"ignored\": false,\n \"reason\": null,\n \"created_at\": \"2012-10-06T21:34:12Z\",\n \"url\": \"https://api.github.com/notifications/threads/1/subscription\",\n \"thread_url\": \"https://api.github.com/notifications/threads/1\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/notifications/threads/{thread_id}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "thread_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})",
+ "html": "await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a thread subscription",
+ "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-thread-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#delete-a-thread-subscription"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "delete-a-thread-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 endpoint and set ignore to true.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/octocat",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "s",
+ "in": "query",
+ "description": "The words to show in Octocat's speech bubble",
+ "schema": {
+ "type": "string"
+ },
+ "required": false,
+ "descriptionHTML": "The words to show in Octocat's speech bubble
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /octocat')",
+ "html": "await octokit.request('GET /octocat')\n
"
+ }
+ ],
+ "summary": "Get Octocat",
+ "description": "Get the octocat as ASCII art",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get-octocat",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "meta"
+ },
+ "slug": "get-octocat",
+ "category": "meta",
+ "categoryLabel": "Meta",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Get the octocat as ASCII art
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/organizations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "since",
+ "description": "An organization ID. Only return organizations with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "An organization ID. Only return organizations with an ID greater than this ID.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /organizations')",
+ "html": "await octokit.request('GET /organizations')\n
"
+ }
+ ],
+ "summary": "List organizations",
+ "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/orgs/#list-organizations"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "list-organizations",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "Get an organization",
+ "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/orgs/#get-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "surtur",
+ "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```",
+ "html": "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.
\nTo access these new parameters during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.surtur-preview+json
"
+ }
+ ],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "get-an-organization",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nGitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with GitHub plan information",
+ "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"plan\": {\n \"name\": \"team\",\n \"space\": 976562499,\n \"private_repos\": 999999,\n \"filled_seats\": 4,\n \"seats\": 5\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /orgs/{org}', {\n org: 'org',\n billing_email: 'billing_email'\n})",
+ "html": "await octokit.request('PATCH /orgs/{org}', {\n org: 'org',\n billing_email: 'billing_email'\n})\n
"
+ }
+ ],
+ "summary": "Update an organization",
+ "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/orgs/#update-an-organization"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "billing_email": {
+ "type": "string",
+ "description": "Billing email address. This address is not publicized.
",
+ "name": "billing_email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Billing email address. This address is not publicized.",
+ "childParamsGroups": []
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name.
",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The company name.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The publicly visible email address.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address.",
+ "childParamsGroups": []
+ },
+ "twitter_username": {
+ "type": "string",
+ "description": "The Twitter username of the company.
",
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The Twitter username of the company.",
+ "childParamsGroups": []
+ },
+ "location": {
+ "type": "string",
+ "description": "The location.
",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The location.",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "The shorthand name of the company.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The shorthand name of the company.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the company.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the company.",
+ "childParamsGroups": []
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "description": "Toggles whether an organization can use organization projects.
",
+ "name": "has_organization_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether an organization can use organization projects.",
+ "childParamsGroups": []
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "description": "Toggles whether repositories that belong to the organization can use repository projects.
",
+ "name": "has_repository_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.",
+ "childParamsGroups": []
+ },
+ "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",
+ "name": "default_repository_permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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
\nNote: 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,
+ "name": "members_can_create_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_internal_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_private_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_public_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.
",
+ "enum": [
+ "all",
+ "private",
+ "none"
+ ],
+ "name": "members_allowed_repository_creation_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "members_can_create_pages",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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`. ",
+ "childParamsGroups": []
+ },
+ "blog": {
+ "type": "string",
+ "example": "\"http://github.blog\"",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "surtur",
+ "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```",
+ "html": "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.
\nTo access these new parameters during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.surtur-preview+json
"
+ }
+ ],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "update-an-organization",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "descriptionHTML": "Parameter Deprecation Notice: GitHub Enterprise Server 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.
\nEnables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Billing email address. This address is not publicized.
",
+ "name": "billing_email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Billing email address. This address is not publicized.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The company name.
",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The company name.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The publicly visible email address.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The Twitter username of the company.
",
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The Twitter username of the company.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The location.
",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The location.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The shorthand name of the company.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The shorthand name of the company.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the company.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the company.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Toggles whether an organization can use organization projects.
",
+ "name": "has_organization_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether an organization can use organization projects.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Toggles whether repositories that belong to the organization can use repository projects.
",
+ "name": "has_repository_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.",
+ "childParamsGroups": []
+ },
+ {
+ "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",
+ "name": "default_repository_permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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
\nNote: 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,
+ "name": "members_can_create_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_internal_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_private_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "members_can_create_public_repositories",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.
",
+ "enum": [
+ "all",
+ "private",
+ "none"
+ ],
+ "name": "members_allowed_repository_creation_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "members_can_create_pages",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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`. ",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"http://github.blog\"",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_pages\": true,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/events', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/events', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List public organization events",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-org-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-public-organization-events"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-organization-events",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/hooks', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/hooks', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List organization webhooks",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-webhooks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#list-organization-webhooks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "list-organization-webhooks",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n \"name\": \"web\",\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"active\": true,\n \"config\": {\n \"url\": \"http://example.com\",\n \"content_type\": \"json\"\n },\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"type\": \"Organization\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/orgs/{org}/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /orgs/{org}/hooks', {\n org: 'org',\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n username: 'username',\n password: 'password'\n }\n})",
+ "html": "await octokit.request('POST /orgs/{org}/hooks', {\n org: 'org',\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n username: 'username',\n password: 'password'\n }\n})\n
"
+ }
+ ],
+ "summary": "Create an organization webhook",
+ "description": "Here's how you can create a hook that posts payloads in JSON format:",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#create-an-organization-webhook"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. Must be passed as \"web\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Must be passed as \"web\".",
+ "childParamsGroups": []
+ },
+ "config": {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "username": {
+ "type": "string",
+ "example": "\"kdaigle\"",
+ "name": "username",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "password": {
+ "type": "string",
+ "example": "\"password\"",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"kdaigle\"",
+ "name": "username",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"password\"",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "config"
+ ]
+ },
+ "example": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "create-an-organization-webhook",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "Here's how you can create a hook that posts payloads in JSON format:
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n \"name\": \"web\",\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"active\": true,\n \"config\": {\n \"url\": \"http://example.com\",\n \"content_type\": \"json\"\n },\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"type\": \"Organization\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. Must be passed as \"web\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Must be passed as \"web\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "username": {
+ "type": "string",
+ "example": "\"kdaigle\"",
+ "name": "username",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "password": {
+ "type": "string",
+ "example": "\"password\"",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"kdaigle\"",
+ "name": "username",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"password\"",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})",
+ "html": "await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an organization webhook",
+ "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#get-an-organization-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "get-an-organization-webhook",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n \"name\": \"web\",\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"active\": true,\n \"config\": {\n \"url\": \"http://example.com\",\n \"content_type\": \"json\"\n },\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"type\": \"Organization\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/orgs/{org}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n }\n})",
+ "html": "await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n }\n})\n
"
+ }
+ ],
+ "summary": "Update an organization webhook",
+ "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#update-an-organization-webhook"
+ },
+ "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.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#update-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "example": "\"web\"",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "update-an-organization-webhook",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n \"name\": \"web\",\n \"events\": [\n \"pull_request\"\n ],\n \"active\": true,\n \"config\": {\n \"url\": \"http://example.com\",\n \"content_type\": \"json\"\n },\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"type\": \"Organization\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#update-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"web\"",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})",
+ "html": "await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete an organization webhook",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#delete-an-organization-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "delete-an-organization-webhook",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/orgs/{org}/hooks/{hook_id}/pings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {\n org: 'org',\n hook_id: 42\n})",
+ "html": "await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {\n org: 'org',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Ping an organization webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.19/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#ping-an-organization-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ },
+ "slug": "ping-an-organization-webhook",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This will trigger a ping event to be sent to the hook.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/installation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/installation', {\n org: 'org',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /orgs/{org}/installation', {\n org: 'org',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get an organization installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-org-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-an-organization-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-an-organization-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"account\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"html_url\": \"https://github.com/github\",\n \"followers_url\": \"https://api.github.com/users/github/followers\",\n \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"repository_selection\": \"all\",\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"created_at\": \"2018-02-09T20:51:14Z\",\n \"updated_at\": \"2018-02-09T20:51:14Z\",\n \"single_file_name\": \"config.yml\",\n \"app_slug\": \"github-actions\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/installations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/orgs/ORG/installations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/installations', {\n org: 'org',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /orgs/{org}/installations', {\n org: 'org',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List app installations for an organization",
+ "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-app-installations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/orgs/#list-app-installations-for-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "orgs"
+ },
+ "slug": "list-app-installations-for-an-organization",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"installations\": [\n {\n \"id\": 25381,\n \"account\": {\n \"login\": \"octo-org\",\n \"id\": 6811672,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\n \"avatar_url\": \"https://avatars3.githubusercontent.com/u/6811672?v=4\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octo-org\",\n \"html_url\": \"https://github.com/octo-org\",\n \"followers_url\": \"https://api.github.com/users/octo-org/followers\",\n \"following_url\": \"https://api.github.com/users/octo-org/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octo-org/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octo-org/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octo-org/orgs\",\n \"repos_url\": \"https://api.github.com/users/octo-org/repos\",\n \"events_url\": \"https://api.github.com/users/octo-org/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octo-org/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"repository_selection\": \"selected\",\n \"access_tokens_url\": \"https://api.github.com/app/installations/25381/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/octo-org/settings/installations/25381\",\n \"app_id\": 2218,\n \"target_id\": 6811672,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"deployments\": \"write\",\n \"metadata\": \"read\",\n \"pull_requests\": \"read\",\n \"statuses\": \"read\"\n },\n \"events\": [\n \"deployment\",\n \"deployment_status\"\n ],\n \"created_at\": \"2017-05-16T08:47:09.000-07:00\",\n \"updated_at\": \"2017-06-06T11:23:23.000-07:00\",\n \"single_file_name\": \"config.yml\",\n \"app_slug\": \"github-actions\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/issues', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/issues', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List organization issues assigned to the authenticated user",
+ "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "list-organization-issues-assigned-to-the-authenticated-user",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List issues in an organization assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/members",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filter members returned in the list. Can be one of:
\n* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
\n* all - All members the authenticated user can see.
"
+ },
+ {
+ "name": "role",
+ "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "admin",
+ "member"
+ ],
+ "default": "all"
+ },
+ "descriptionHTML": "Filter members returned by their role. Can be one of:
\n* all - All members of the organization, regardless of role.
\n* admin - Organization owners.
\n* member - Non-owner organization members.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/members', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/members', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List organization members",
+ "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-members",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#list-organization-members"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "list-organization-members",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Response if requester is not an organization member"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Check organization membership for a user",
+ "description": "Check if a user is, publicly or privately, a member of the organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/check-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#check-organization-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "check-organization-membership-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if requester is an organization member and user is a member"
+ },
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Response if requester is not an organization member"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if requester is an organization member and user is not a member"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove an organization member",
+ "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-member",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#remove-an-organization-member"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "remove-an-organization-member",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get organization membership for a user",
+ "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#get-organization-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "get-organization-membership-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has an active admin membership with organization",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has an active membership with organization",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"member\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has a pending membership with organization",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n \"state\": \"pending\",\n \"role\": \"member\",\n \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/orgs/{org}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username',\n role: 'role'\n})",
+ "html": "await octokit.request('PUT /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username',\n role: 'role'\n})\n
"
+ }
+ ],
+ "summary": "Set organization membership for a user",
+ "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/set-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#set-organization-membership-for-a-user"
+ },
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "set-organization-membership-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "descriptionHTML": "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 will be
pending until they accept the invitation. \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
\nRate limits
\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.
",
+ "bodyParameters": [
+ {
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user was previously unaffiliated with organization",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n \"state\": \"pending\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user already had membership with organization",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove organization membership for a user",
+ "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#remove-organization-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "remove-organization-membership-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/outside_collaborators",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filter the list of outside collaborators. Can be one of:
\n* 2fa_disabled: Outside collaborators without two-factor authentication enabled.
\n* all: All outside collaborators.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/outside_collaborators', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/outside_collaborators', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List outside collaborators for an organization",
+ "description": "List all users who are outside collaborators of an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-outside-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#list-outside-collaborators-for-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ },
+ "slug": "list-outside-collaborators-for-an-organization",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "outside-collaborators",
+ "subcategoryLabel": "Outside collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all users who are outside collaborators of an organization.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/orgs/{org}/outside_collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Convert an organization member to outside collaborator",
+ "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/convert-member-to-outside-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ },
+ "slug": "convert-an-organization-member-to-outside-collaborator",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "outside-collaborators",
+ "subcategoryLabel": "Outside collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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\".
",
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "User is getting converted asynchronously"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "User was converted"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Response if user is the last owner of the organization",
+ "payload": "{\n \"message\": \"Cannot convert the last owner to an outside collaborator\",\n \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Response if user is not a member of the organization",
+ "payload": "{\n \"message\": \"<user> is not a member of the <organization> organization.\",\n \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/outside_collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove outside collaborator from an organization",
+ "description": "Removing a user from this list will remove them from all the organization's repositories.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-outside-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#remove-outside-collaborator-from-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ },
+ "slug": "remove-outside-collaborator-from-an-organization",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "outside-collaborators",
+ "subcategoryLabel": "Outside collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if user is a member of the organization",
+ "payload": "{\n \"message\": \"You cannot specify an organization member to remove as an outside collaborator.\",\n \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#remove-outside-collaborator\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/pre-receive-hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/pre-receive-hooks', {\n org: 'org',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /orgs/{org}/pre-receive-hooks', {\n org: 'org',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List pre-receive hooks for an organization",
+ "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.",
+ "operationId": "enterprise-admin/list-pre-receive-hooks-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ },
+ "slug": "list-pre-receive-hooks-for-an-organization",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "org-pre-receive-hooks",
+ "subcategoryLabel": "Org pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\n \"allow_downstream_configuration\": true\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}', {\n org: 'org',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}', {\n org: 'org',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a pre-receive hook for an organization",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ },
+ "slug": "get-a-pre-receive-hook-for-an-organization",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "org-pre-receive-hooks",
+ "subcategoryLabel": "Org pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\n \"allow_downstream_configuration\": true\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}', {\n org: 'org',\n pre_receive_hook_id: 42,\n enforcement: 'enforcement',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}', {\n org: 'org',\n pre_receive_hook_id: 42,\n enforcement: 'enforcement',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update pre-receive hook enforcement for an organization",
+ "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`",
+ "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enforcement": {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ },
+ "allow_downstream_configuration": {
+ "description": "Whether repositories can override enforcement.
",
+ "type": "boolean",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether repositories can override enforcement.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ },
+ "slug": "update-pre-receive-hook-enforcement-for-an-organization",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "org-pre-receive-hooks",
+ "subcategoryLabel": "Org pre receive hooks",
+ "notes": [],
+ "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
",
+ "bodyParameters": [
+ {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether repositories can override enforcement.
",
+ "type": "boolean",
+ "name": "allow_downstream_configuration",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether repositories can override enforcement.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"enabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\",\n \"allow_downstream_configuration\": false\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/orgs/ORG/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}', {\n org: 'org',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}', {\n org: 'org',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove pre-receive hook enforcement for an organization",
+ "description": "Removes any overrides for this hook at the org level for this org.",
+ "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ },
+ "slug": "remove-pre-receive-hook-enforcement-for-an-organization",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "org-pre-receive-hooks",
+ "subcategoryLabel": "Org pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\n \"allow_downstream_configuration\": true\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/projects', {\n org: 'org',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /orgs/{org}/projects', {\n org: 'org',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List organization projects",
+ "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#list-organization-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "list-organization-projects",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/orgs/octocat\",\n \"url\": \"https://api.github.com/projects/1002605\",\n \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n \"id\": 1002605,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n \"name\": \"Organization Roadmap\",\n \"body\": \"High-level roadmap for the upcoming year.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-11T20:09:31Z\",\n \"updated_at\": \"2014-03-04T18:58:10Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/orgs/{org}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /orgs/{org}/projects', {\n org: 'org',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /orgs/{org}/projects', {\n org: 'org',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create an organization project",
+ "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#create-an-organization-project"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the project.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the project.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "create-an-organization-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the project.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the project.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/orgs/octocat\",\n \"url\": \"https://api.github.com/projects/1002605\",\n \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n \"id\": 1002605,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n \"name\": \"Organization Roadmap\",\n \"body\": \"High-level roadmap for the upcoming year.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-11T20:09:31Z\",\n \"updated_at\": \"2014-03-04T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/public_members",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/public_members', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/public_members', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List public organization members",
+ "description": "Members of an organization can choose to have their membership publicized or not.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-public-members",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#list-public-organization-members"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "list-public-organization-members",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/public_members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Check public organization membership for a user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/check-public-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#check-public-organization-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "check-public-organization-membership-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if user is a public member"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if user is not a public member"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/orgs/{org}/public_members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Set public organization membership for the authenticated user",
+ "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/set-public-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "set-public-organization-membership-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/orgs/{org}/public_members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove public organization membership for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-public-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "remove-public-organization-membership-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ ]
+ },
+ "descriptionHTML": "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.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Can be one of created, updated, pushed, full_name.
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be one of asc or desc. Default: when using full_name: asc, otherwise desc
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/repos', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/repos', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List organization repositories",
+ "description": "Lists repositories for the specified organization.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-organization-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/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://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "The is_template and template_repository keys are currently available for developer to preview. See 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 in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-organization-repositories",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories for the specified organization.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/orgs/{org}/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /orgs/{org}/repos', {\n org: 'org',\n name: 'name'\n})",
+ "html": "await octokit.request('POST /orgs/{org}/repos', {\n org: 'org',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Create an organization repository",
+ "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#create-an-organization-repository"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ "homepage": {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either true to create a private repository or false to create a public one.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to create a private repository or `false` to create a public one.",
+ "childParamsGroups": []
+ },
+ "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\" 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"
+ ],
+ "name": "visibility",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "has_issues": {
+ "type": "boolean",
+ "description": "Either true to enable issues for this repository or false to disable them.
",
+ "default": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "has_wiki": {
+ "type": "boolean",
+ "description": "Either true to enable the wiki for this repository or false to disable it.
",
+ "default": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.",
+ "childParamsGroups": []
+ },
+ "is_template": {
+ "type": "boolean",
+ "description": "Either true to make this repo available as a template repository or false to prevent it.
",
+ "default": false,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ "auto_init": {
+ "type": "boolean",
+ "description": "Pass true to create an initial commit with empty README.
",
+ "default": false,
+ "name": "auto_init",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Pass `true` to create an initial commit with empty README.",
+ "childParamsGroups": []
+ },
+ "gitignore_template": {
+ "type": "string",
+ "description": "Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".
",
+ "name": "gitignore_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\".",
+ "childParamsGroups": []
+ },
+ "license_template": {
+ "type": "string",
+ "description": "Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".
",
+ "name": "license_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\".",
+ "childParamsGroups": []
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "description": "Either true to allow squash-merging pull requests, or false to prevent squash-merging.
",
+ "default": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
+ "childParamsGroups": []
+ },
+ "allow_rebase_merge": {
+ "type": "boolean",
+ "description": "Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
",
+ "default": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.",
+ "childParamsGroups": []
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/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://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "The is_template and template_repository keys are currently available for developer to preview. See 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 in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "create-an-organization-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repository
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to create a private repository or false to create a public one.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to create a private repository or `false` to create a public one.",
+ "childParamsGroups": []
+ },
+ {
+ "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\" 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"
+ ],
+ "name": "visibility",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to enable issues for this repository or false to disable them.
",
+ "default": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to enable the wiki for this repository or false to disable it.
",
+ "default": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to make this repo available as a template repository or false to prevent it.
",
+ "default": false,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Pass true to create an initial commit with empty README.
",
+ "default": false,
+ "name": "auto_init",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Pass `true` to create an initial commit with empty README.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".
",
+ "name": "gitignore_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".
",
+ "name": "license_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to allow squash-merging pull requests, or false to prevent squash-merging.
",
+ "default": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
",
+ "default": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
",
+ "default": false,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/teams', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/teams', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List teams",
+ "description": "Lists all teams in an organization that are visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#list-teams"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-teams",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all teams in an organization that are visible to the authenticated user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/orgs/{org}/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /orgs/{org}/teams', {\n org: 'org',\n name: 'name'\n})",
+ "html": "await octokit.request('POST /orgs/{org}/teams', {\n org: 'org',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Create a team",
+ "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#create-a-team"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the team.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the team.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ "maintainers": {
+ "type": "array of strings",
+ "description": "List GitHub IDs for organization members who will become team maintainers.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "maintainers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List GitHub IDs for organization members who will become team maintainers.",
+ "childParamsGroups": []
+ },
+ "repo_names": {
+ "type": "array of strings",
+ "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "repo_names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
+ "childParamsGroups": []
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. The options are:
\nFor 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
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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.",
+ "childParamsGroups": []
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "admin",
+ "privacy": "closed"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "create-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "descriptionHTML": "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.\"
\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the team.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "List GitHub IDs for organization members who will become team maintainers.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "maintainers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "List GitHub IDs for organization members who will become team maintainers.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "repo_names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The level of privacy this team should have. The options are:
\nFor 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
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ {
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/orgs/{org}/teams/{team_slug}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "team_slug",
+ "description": "team_slug parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "team_slug parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug'\n})",
+ "html": "await octokit.request('GET /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug'\n})\n
"
+ }
+ ],
+ "summary": "Get a team by name",
+ "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-by-name",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#get-a-team-by-name"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "get-a-team-by-name",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/columns/cards/{card_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "card_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#get-a-project-card"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ },
+ "slug": "get-a-project-card",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "cards",
+ "subcategoryLabel": "Cards",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n \"id\": 1478,\n \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n \"note\": \"Add payload for delete Project column\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2016-09-05T14:21:06Z\",\n \"updated_at\": \"2016-09-05T14:20:22Z\",\n \"archived\": false,\n \"column_url\": \"https://api.github.com/projects/columns/367\",\n \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n \"project_url\": \"https://api.github.com/projects/120\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/projects/columns/cards/{card_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "card_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /projects/columns/cards/{card_id}', {\n card_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /projects/columns/cards/{card_id}', {\n card_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update an existing project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/update-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#update-a-project-card"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "note": {
+ "description": "The project card's note
",
+ "example": "Update all gems",
+ "type": "string or null",
+ "nullable": true,
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The project card's note",
+ "childParamsGroups": []
+ },
+ "archived": {
+ "description": "Whether or not the card is archived
",
+ "example": false,
+ "type": "boolean",
+ "name": "archived",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether or not the card is archived",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ },
+ "slug": "update-an-existing-project-card",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "cards",
+ "subcategoryLabel": "Cards",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "The project card's note
",
+ "example": "Update all gems",
+ "type": "string or null",
+ "nullable": true,
+ "name": "note",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The project card's note",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether or not the card is archived
",
+ "example": false,
+ "type": "boolean",
+ "name": "archived",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether or not the card is archived",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n \"id\": 1478,\n \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n \"note\": \"Add payload for delete Project column\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2016-09-05T14:21:06Z\",\n \"updated_at\": \"2016-09-05T14:20:22Z\",\n \"archived\": false,\n \"column_url\": \"https://api.github.com/projects/columns/367\",\n \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n \"project_url\": \"https://api.github.com/projects/120\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/projects/columns/cards/{card_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "card_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/delete-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#delete-a-project-card"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ },
+ "slug": "delete-a-project-card",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "cards",
+ "subcategoryLabel": "Cards",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/projects/columns/cards/{card_id}/moves",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "card_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /projects/columns/cards/{card_id}/moves', {\n card_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /projects/columns/cards/{card_id}/moves', {\n card_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Move a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/move-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#move-a-project-card"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "position": {
+ "description": "Required. The position of the card in a column
",
+ "example": "bottom",
+ "type": "string",
+ "pattern": "^(?:top|bottom|after:\\d+)$",
+ "name": "position",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The position of the card in a column",
+ "childParamsGroups": []
+ },
+ "column_id": {
+ "description": "The unique identifier of the column the card should be moved to
",
+ "example": 42,
+ "type": "integer",
+ "name": "column_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The unique identifier of the column the card should be moved to",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ },
+ "slug": "move-a-project-card",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "cards",
+ "subcategoryLabel": "Cards",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. The position of the card in a column
",
+ "example": "bottom",
+ "type": "string",
+ "pattern": "^(?:top|bottom|after:\\d+)$",
+ "name": "position",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The position of the card in a column",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The unique identifier of the column the card should be moved to
",
+ "example": 42,
+ "type": "integer",
+ "name": "column_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The unique identifier of the column the card should be moved to",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/columns/{column_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "column_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#get-a-project-column"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ },
+ "slug": "get-a-project-column",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "columns",
+ "subcategoryLabel": "Columns",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/projects/columns/367\",\n \"project_url\": \"https://api.github.com/projects/120\",\n \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n \"id\": 367,\n \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n \"name\": \"To Do\",\n \"created_at\": \"2016-09-05T14:18:44Z\",\n \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/projects/columns/{column_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "column_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /projects/columns/{column_id}', {\n column_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /projects/columns/{column_id}', {\n column_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update an existing project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/update-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#update-a-project-column"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Required. Name of the project column
",
+ "example": "Remaining tasks",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project column",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ },
+ "slug": "update-an-existing-project-column",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "columns",
+ "subcategoryLabel": "Columns",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. Name of the project column
",
+ "example": "Remaining tasks",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project column",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/projects/columns/367\",\n \"project_url\": \"https://api.github.com/projects/120\",\n \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n \"id\": 367,\n \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n \"name\": \"To Do\",\n \"created_at\": \"2016-09-05T14:18:44Z\",\n \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/projects/columns/{column_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "column_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/delete-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#delete-a-project-column"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ },
+ "slug": "delete-a-project-column",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "columns",
+ "subcategoryLabel": "Columns",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/columns/{column_id}/cards",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "column_id parameter
"
+ },
+ {
+ "name": "archived_state",
+ "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "archived",
+ "not_archived"
+ ],
+ "default": "not_archived"
+ },
+ "descriptionHTML": "Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/columns/{column_id}/cards', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/columns/{column_id}/cards', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List project cards",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-cards",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#list-project-cards"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ },
+ "slug": "list-project-cards",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "cards",
+ "subcategoryLabel": "Cards",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n \"id\": 1478,\n \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n \"note\": \"Add payload for delete Project column\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2016-09-05T14:21:06Z\",\n \"updated_at\": \"2016-09-05T14:20:22Z\",\n \"archived\": false,\n \"column_url\": \"https://api.github.com/projects/columns/367\",\n \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n \"project_url\": \"https://api.github.com/projects/120\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/projects/columns/{column_id}/cards",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "column_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /projects/columns/{column_id}/cards', {\n column_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /projects/columns/{column_id}/cards', {\n column_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a project card",
+ "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#create-a-project-card"
+ },
+ "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"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ },
+ "slug": "create-a-project-card",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "cards",
+ "subcategoryLabel": "Cards",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nBe aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n \"id\": 1478,\n \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n \"note\": \"Add payload for delete Project column\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2016-09-05T14:21:06Z\",\n \"updated_at\": \"2016-09-05T14:20:22Z\",\n \"archived\": false,\n \"column_url\": \"https://api.github.com/projects/columns/367\",\n \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n \"project_url\": \"https://api.github.com/projects/120\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/projects/columns/{column_id}/moves",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "column_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /projects/columns/{column_id}/moves', {\n column_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /projects/columns/{column_id}/moves', {\n column_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Move a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/move-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#move-a-project-column"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "position": {
+ "description": "Required. The position of the column in a project
",
+ "example": "last",
+ "type": "string",
+ "pattern": "^(?:first|last|after:\\d+)$",
+ "name": "position",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The position of the column in a project",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ },
+ "slug": "move-a-project-column",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "columns",
+ "subcategoryLabel": "Columns",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. The position of the column in a project
",
+ "example": "last",
+ "type": "string",
+ "pattern": "^(?:first|last|after:\\d+)$",
+ "name": "position",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The position of the column in a project",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a project",
+ "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#get-a-project"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "get-a-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n \"url\": \"https://api.github.com/projects/1002604\",\n \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n \"id\": 1002604,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n \"name\": \"Projects Documentation\",\n \"body\": \"Developer documentation project for the developer site.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /projects/{project_id}', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /projects/{project_id}', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a project",
+ "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "operationId": "projects/update",
+ "tags": [
+ "projects"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#update-a-project"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Name of the project
",
+ "example": "Week One Sprint",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project",
+ "childParamsGroups": []
+ },
+ "body": {
+ "description": "Body of the project
",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string or null",
+ "nullable": true,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Body of the project",
+ "childParamsGroups": []
+ },
+ "state": {
+ "description": "State of the project; either 'open' or 'closed'
",
+ "example": "open",
+ "type": "string",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of the project; either 'open' or 'closed'",
+ "childParamsGroups": []
+ },
+ "organization_permission": {
+ "description": "The baseline permission that all organization members have on this project
",
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "none"
+ ],
+ "name": "organization_permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The baseline permission that all organization members have on this project",
+ "childParamsGroups": []
+ },
+ "private": {
+ "description": "Whether or not this project can be seen by everyone.
",
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether or not this project can be seen by everyone.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "update-a-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "Name of the project
",
+ "example": "Week One Sprint",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Body of the project
",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string or null",
+ "nullable": true,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Body of the project",
+ "childParamsGroups": []
+ },
+ {
+ "description": "State of the project; either 'open' or 'closed'
",
+ "example": "open",
+ "type": "string",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of the project; either 'open' or 'closed'",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The baseline permission that all organization members have on this project
",
+ "type": "string",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "none"
+ ],
+ "name": "organization_permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The baseline permission that all organization members have on this project",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether or not this project can be seen by everyone.
",
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether or not this project can be seen by everyone.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n \"url\": \"https://api.github.com/projects/1002604\",\n \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n \"id\": 1002604,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n \"name\": \"Projects Documentation\",\n \"body\": \"Developer documentation project for the developer site.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if the authenticated user does not have access to the project"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a project",
+ "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.",
+ "operationId": "projects/delete",
+ "tags": [
+ "projects"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#delete-a-project"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "delete-a-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Delete success"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes a project board. Returns a 404 Not Found status if projects are disabled.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/{project_id}/collaborators",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filters the collaborators by their affiliation. Can be one of:
\n* outside: Outside collaborators of a project that are not a member of the project's organization.
\n* direct: Collaborators with permissions to a project, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/{project_id}/collaborators', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/{project_id}/collaborators', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List project collaborators",
+ "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#list-project-collaborators"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "collaborators"
+ },
+ "slug": "list-project-collaborators",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/projects/{project_id}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add project collaborator",
+ "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/add-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#add-project-collaborator"
+ },
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the collaborator.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "collaborators"
+ },
+ "slug": "add-project-collaborator",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "The permission to grant the collaborator.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "default": "write",
+ "example": "write",
+ "type": "string",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the collaborator.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/projects/{project_id}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove user as a collaborator",
+ "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/remove-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#remove-project-collaborator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "collaborators"
+ },
+ "slug": "remove-user-as-a-collaborator",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/{project_id}/collaborators/{username}/permission",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get project permission for a user",
+ "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-permission-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#get-project-permission-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "collaborators"
+ },
+ "slug": "get-project-permission-for-a-user",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"permission\": \"admin\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/projects/{project_id}/columns",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /projects/{project_id}/columns', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /projects/{project_id}/columns', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List project columns",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-columns",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#list-project-columns"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ },
+ "slug": "list-project-columns",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "columns",
+ "subcategoryLabel": "Columns",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/projects/columns/367\",\n \"project_url\": \"https://api.github.com/projects/120\",\n \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n \"id\": 367,\n \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n \"name\": \"To Do\",\n \"created_at\": \"2016-09-05T14:18:44Z\",\n \"updated_at\": \"2016-09-05T14:22:28Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/projects/{project_id}/columns",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /projects/{project_id}/columns', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /projects/{project_id}/columns', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/projects#create-a-project-column"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Required. Name of the project column
",
+ "example": "Remaining tasks",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project column",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ },
+ "slug": "create-a-project-column",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "subcategory": "columns",
+ "subcategoryLabel": "Columns",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. Name of the project column
",
+ "example": "Remaining tasks",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project column",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response",
+ "payload": "{\n \"url\": \"https://api.github.com/projects/columns/367\",\n \"project_url\": \"https://api.github.com/projects/120\",\n \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n \"id\": 367,\n \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n \"name\": \"To Do\",\n \"created_at\": \"2016-09-05T14:18:44Z\",\n \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/rate_limit",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /rate_limit')",
+ "html": "await octokit.request('GET /rate_limit')\n
"
+ }
+ ],
+ "summary": "Get rate limit status for the authenticated user",
+ "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
+ "tags": [
+ "rate-limit"
+ ],
+ "operationId": "rate-limit/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/rate_limit/#get-rate-limit-status-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "rate-limit",
+ "subcategory": null
+ },
+ "slug": "get-rate-limit-status-for-the-authenticated-user",
+ "category": "rate-limit",
+ "categoryLabel": "Rate limit",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"resources\": {\n \"core\": {\n \"limit\": 5000,\n \"remaining\": 4999,\n \"reset\": 1372700873\n },\n \"search\": {\n \"limit\": 30,\n \"remaining\": 18,\n \"reset\": 1372697452\n },\n \"graphql\": {\n \"limit\": 5000,\n \"remaining\": 4993,\n \"reset\": 1372700389\n },\n \"integration_manifest\": {\n \"limit\": 5000,\n \"remaining\": 4999,\n \"reset\": 1551806725\n },\n \"code_scanning_upload\": {\n \"limit\": 500,\n \"remaining\": 499,\n \"reset\": 1551806725\n }\n },\n \"rate\": {\n \"limit\": 5000,\n \"remaining\": 4999,\n \"reset\": 1372700873\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/reactions/{reaction_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "reaction_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/reactions/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/reactions/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42\n})",
+ "html": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a reaction",
+ "description": "OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#discussion-comments).",
+ "operationId": "reactions/delete",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#delete-a-reaction"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions"
+ },
+ "slug": "delete-a-reaction",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a repository",
+ "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#get-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.nebula-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```",
+ "html": "The Codes of Conduct API is currently available for developers to preview.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.scarlet-witch-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "get-a-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThe parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"forks\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"open_issues\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"pull\": true,\n \"push\": false,\n \"admin\": false\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"organization\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"parent\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n },\n \"source\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n },\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with scarlet-witch-preview media type",
+ "payload": "{\n \"id\": 88760408,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnk4ODc2MDQwOA==\",\n \"name\": \"cosee\",\n \"full_name\": \"LindseyB/cosee\",\n \"disabled\": false,\n \"archived\": false,\n \"owner\": {\n \"login\": \"LindseyB\",\n \"id\": 33750,\n \"node_id\": \"MDQ6VXNlcjMzNzUw\",\n \"avatar_url\": \"https://avatars2.githubusercontent.com/u/33750?v=3\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/LindseyB\",\n \"html_url\": \"https://github.com/LindseyB\",\n \"followers_url\": \"https://api.github.com/users/LindseyB/followers\",\n \"following_url\": \"https://api.github.com/users/LindseyB/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/LindseyB/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/LindseyB/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/LindseyB/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/LindseyB/orgs\",\n \"repos_url\": \"https://api.github.com/users/LindseyB/repos\",\n \"events_url\": \"https://api.github.com/users/LindseyB/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/LindseyB/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"private\": false,\n \"html_url\": \"https://github.com/LindseyB/cosee\",\n \"description\": null,\n \"fork\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://github.com/licenses/mit\"\n },\n \"url\": \"https://api.github.com/repos/LindseyB/cosee\",\n \"forks_url\": \"https://api.github.com/repos/LindseyB/cosee/forks\",\n \"keys_url\": \"https://api.github.com/repos/LindseyB/cosee/keys{/key_id}\",\n \"collaborators_url\": \"https://api.github.com/repos/LindseyB/cosee/collaborators{/collaborator}\",\n \"teams_url\": \"https://api.github.com/repos/LindseyB/cosee/teams\",\n \"hooks_url\": \"https://api.github.com/repos/LindseyB/cosee/hooks\",\n \"issue_events_url\": \"https://api.github.com/repos/LindseyB/cosee/issues/events{/number}\",\n \"events_url\": \"https://api.github.com/repos/LindseyB/cosee/events\",\n \"assignees_url\": \"https://api.github.com/repos/LindseyB/cosee/assignees{/user}\",\n \"branches_url\": \"https://api.github.com/repos/LindseyB/cosee/branches{/branch}\",\n \"tags_url\": \"https://api.github.com/repos/LindseyB/cosee/tags\",\n \"blobs_url\": \"https://api.github.com/repos/LindseyB/cosee/git/blobs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/LindseyB/cosee/git/tags{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/LindseyB/cosee/git/refs{/sha}\",\n \"trees_url\": \"https://api.github.com/repos/LindseyB/cosee/git/trees{/sha}\",\n \"statuses_url\": \"https://api.github.com/repos/LindseyB/cosee/statuses/{sha}\",\n \"languages_url\": \"https://api.github.com/repos/LindseyB/cosee/languages\",\n \"stargazers_url\": \"https://api.github.com/repos/LindseyB/cosee/stargazers\",\n \"contributors_url\": \"https://api.github.com/repos/LindseyB/cosee/contributors\",\n \"subscribers_url\": \"https://api.github.com/repos/LindseyB/cosee/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/LindseyB/cosee/subscription\",\n \"commits_url\": \"https://api.github.com/repos/LindseyB/cosee/commits{/sha}\",\n \"git_commits_url\": \"https://api.github.com/repos/LindseyB/cosee/git/commits{/sha}\",\n \"comments_url\": \"https://api.github.com/repos/LindseyB/cosee/comments{/number}\",\n \"issue_comment_url\": \"https://api.github.com/repos/LindseyB/cosee/issues/comments{/number}\",\n \"contents_url\": \"https://api.github.com/repos/LindseyB/cosee/contents/{+path}\",\n \"compare_url\": \"https://api.github.com/repos/LindseyB/cosee/compare/{base}...{head}\",\n \"merges_url\": \"https://api.github.com/repos/LindseyB/cosee/merges\",\n \"archive_url\": \"https://api.github.com/repos/LindseyB/cosee/{archive_format}{/ref}\",\n \"downloads_url\": \"https://api.github.com/repos/LindseyB/cosee/downloads\",\n \"issues_url\": \"https://api.github.com/repos/LindseyB/cosee/issues{/number}\",\n \"pulls_url\": \"https://api.github.com/repos/LindseyB/cosee/pulls{/number}\",\n \"milestones_url\": \"https://api.github.com/repos/LindseyB/cosee/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/LindseyB/cosee/notifications{?since,all,participating}\",\n \"labels_url\": \"https://api.github.com/repos/LindseyB/cosee/labels{/name}\",\n \"releases_url\": \"https://api.github.com/repos/LindseyB/cosee/releases{/id}\",\n \"deployments_url\": \"https://api.github.com/repos/LindseyB/cosee/deployments\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"git_url\": \"git://github.com/LindseyB/cosee.git\",\n \"ssh_url\": \"git@github.com=>LindseyB/cosee.git\",\n \"clone_url\": \"https://github.com/LindseyB/cosee.git\",\n \"svn_url\": \"https://github.com/LindseyB/cosee\",\n \"homepage\": null,\n \"size\": 1,\n \"stargazers_count\": 0,\n \"watchers_count\": 0,\n \"language\": null,\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_downloads\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"forks_count\": 0,\n \"mirror_url\": null,\n \"open_issues_count\": 0,\n \"forks\": 0,\n \"open_issues\": 0,\n \"watchers\": 0,\n \"default_branch\": \"master\",\n \"network_count\": 0,\n \"subscribers_count\": 0\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update a repository",
+ "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#replace-all-repository-topics) endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#update-a-repository"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ "homepage": {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility 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 to organization owners and a non-owner tries to change the value of private.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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"
+ ],
+ "name": "visibility",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "has_issues": {
+ "type": "boolean",
+ "description": "Either true to enable issues for this repository or false to disable them.
",
+ "default": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "has_wiki": {
+ "type": "boolean",
+ "description": "Either true to enable the wiki for this repository or false to disable it.
",
+ "default": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.",
+ "childParamsGroups": []
+ },
+ "is_template": {
+ "type": "boolean",
+ "description": "Either true to make this repo available as a template repository or false to prevent it.
",
+ "default": false,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
+ "childParamsGroups": []
+ },
+ "default_branch": {
+ "type": "string",
+ "description": "Updates the default branch for this repository.
",
+ "name": "default_branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Updates the default branch for this repository.",
+ "childParamsGroups": []
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "description": "Either true to allow squash-merging pull requests, or false to prevent squash-merging.
",
+ "default": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
+ "childParamsGroups": []
+ },
+ "allow_rebase_merge": {
+ "type": "boolean",
+ "description": "Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
",
+ "default": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.",
+ "childParamsGroups": []
+ },
+ "archived": {
+ "type": "boolean",
+ "description": "true to archive this repository. Note: You cannot unarchive repositories through the API.
",
+ "default": false,
+ "name": "archived",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/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://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "The is_template and template_repository keys are currently available for developer to preview. See 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 in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "update-a-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "Note: To edit a repository's topics, use the Replace all repository topics endpoint.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The name of the repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A URL with more information about the repository.
",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility 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 to organization owners and a non-owner tries to change the value of private.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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"
+ ],
+ "name": "visibility",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to enable issues for this repository or false to disable them.
",
+ "default": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to enable the wiki for this repository or false to disable it.
",
+ "default": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to make this repo available as a template repository or false to prevent it.
",
+ "default": false,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Updates the default branch for this repository.
",
+ "name": "default_branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Updates the default branch for this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to allow squash-merging pull requests, or false to prevent squash-merging.
",
+ "default": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
",
+ "default": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
",
+ "default": false,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to archive this repository. Note: You cannot unarchive repositories through the API.
",
+ "default": false,
+ "name": "archived",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://github.com/licenses/mit\"\n },\n \"forks_count\": 9,\n \"forks\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"open_issues\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"pull\": true,\n \"push\": false,\n \"admin\": false\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"organization\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"parent\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n },\n \"source\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n },\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository",
+ "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#delete-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "delete-a-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "If an organization owner has configured the organization to prevent members from deleting organization owned repositories a member will get this response",
+ "payload": "{\n \"message\": \"Organization members cannot delete repositories.\",\n \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-repository\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/assignees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/assignees', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/assignees', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List assignees",
+ "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-assignees"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "assignees"
+ },
+ "slug": "list-assignees",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "assignees",
+ "subcategoryLabel": "Assignees",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the available assignees for issues in a repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "assignee",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/assignees/ASSIGNEE
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/assignees/{assignee}', {\n owner: 'octocat',\n repo: 'hello-world',\n assignee: 'assignee'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/assignees/{assignee}', {\n owner: 'octocat',\n repo: 'hello-world',\n assignee: 'assignee'\n})\n
"
+ }
+ ],
+ "summary": "Check if a user can be assigned",
+ "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/check-user-can-be-assigned",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#check-if-a-user-can-be-assigned"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "assignees"
+ },
+ "slug": "check-if-a-user-can-be-assigned",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "assignees",
+ "subcategoryLabel": "Assignees",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "If the assignee can be assigned to issues in the repository a 204 header with no content is returned"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Otherwise a 404 status code is returned"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Checks if a user has permission to be assigned to an issue in this repository.
\nIf the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
\nOtherwise a 404 status code is returned.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List branches",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-branches",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-branches"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "list-branches",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"name\": \"master\",\n \"commit\": {\n \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n },\n \"protected\": true\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "With protection",
+ "payload": "[\n {\n \"name\": \"master\",\n \"commit\": {\n \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n },\n \"protected\": true,\n \"protection\": {\n \"enabled\": true,\n \"required_status_checks\": {\n \"enforcement_level\": \"non_admins\",\n \"contexts\": [\n \"ci-test\",\n \"linter\"\n ]\n }\n },\n \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get a branch",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-branch"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-a-branch",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"name\": \"master\",\n \"commit\": {\n \"sha\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"node_id\": \"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\n \"commit\": {\n \"author\": {\n \"name\": \"The Octocat\",\n \"date\": \"2012-03-06T15:06:50-08:00\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"tree\": {\n \"sha\": \"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"date\": \"2012-03-06T15:06:50-08:00\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n },\n \"comment_count\": 0\n },\n \"author\": {\n \"gravatar_id\": \"\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"id\": 583231,\n \"login\": \"octocat\",\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"parents\": [\n {\n \"sha\": \"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"\n },\n {\n \"sha\": \"762941318ee16e59dabbacb1b4049eec22f0d303\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"\n }\n ],\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"committer\": {\n \"gravatar_id\": \"\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"id\": 583231,\n \"login\": \"octocat\",\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\"\n },\n \"_links\": {\n \"html\": \"https://github.com/octocat/Hello-World/tree/master\",\n \"self\": \"https://api.github.com/repos/octocat/Hello-World/branches/master\"\n },\n \"protected\": true,\n \"protection\": {\n \"enabled\": true,\n \"required_status_checks\": {\n \"enforcement_level\": \"non_admins\",\n \"contexts\": [\n \"ci-test\",\n \"linter\"\n ]\n }\n },\n \"protection_url\": \"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get branch protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-branch-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.luke-cage-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-branch-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\n \"enabled\": true,\n \"required_status_checks\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\n \"contexts\": [\n \"continuous-integration/travis-ci\"\n ],\n \"contexts_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\n \"enforcement_level\": \"non_admins\"\n },\n \"enforce_admins\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\n \"enabled\": true\n },\n \"required_pull_request_reviews\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\n \"dismissal_restrictions\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\n \"users_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\n \"users\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ]\n },\n \"dismiss_stale_reviews\": true,\n \"require_code_owner_reviews\": true,\n \"required_approving_review_count\": 2\n },\n \"restrictions\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\n \"users_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\n \"apps_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\n \"users\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ],\n \"apps\": [\n {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n }\n ]\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update branch protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-branch-protection"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required_status_checks": {
+ "type": "object or null",
+ "description": "Required. Require status checks to pass before merging. Set to null to disable.
",
+ "nullable": true,
+ "properties": {
+ "strict": {
+ "type": "boolean",
+ "description": "Required. Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ "contexts": {
+ "type": "array of strings",
+ "description": "Required. The list of status checks to require in order to merge into this branch
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of status checks to require in order to merge into this branch",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "strict",
+ "contexts"
+ ],
+ "name": "required_status_checks",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.",
+ "childParamsGroups": [
+ {
+ "parentName": "required_status_checks",
+ "parentType": "object",
+ "id": "required_status_checks-object",
+ "params": [
+ {
+ "type": "boolean",
+ "description": "Required. Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Required. The list of status checks to require in order to merge into this branch
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of status checks to require in order to merge into this branch",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "enforce_admins": {
+ "type": "boolean or null",
+ "description": "Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
",
+ "nullable": true,
+ "name": "enforce_admins",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.",
+ "childParamsGroups": []
+ },
+ "required_pull_request_reviews": {
+ "type": "object or null",
+ "description": "Required. 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 of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ },
+ "name": "dismissal_restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean",
+ "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
",
+ "name": "dismiss_stale_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
+ "childParamsGroups": []
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until code owners review them.
",
+ "name": "require_code_owner_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.",
+ "childParamsGroups": []
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "required_pull_request_reviews",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.",
+ "childParamsGroups": [
+ {
+ "parentName": "required_pull_request_reviews",
+ "parentType": "object",
+ "id": "required_pull_request_reviews-object",
+ "params": [
+ {
+ "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 of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ },
+ "name": "dismissal_restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "boolean",
+ "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
",
+ "name": "dismiss_stale_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until code owners review them.
",
+ "name": "require_code_owner_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "restrictions": {
+ "type": "object or null",
+ "description": "Required. 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 of strings",
+ "description": "Required. The list of user logins with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with push access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "Required. The list of team slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with push access",
+ "childParamsGroups": []
+ },
+ "apps": {
+ "type": "array of strings",
+ "description": "The list of app slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of app `slug`s with push access",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "users",
+ "teams"
+ ],
+ "name": "restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "restrictions",
+ "parentType": "object",
+ "id": "restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "Required. The list of user logins with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with push access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Required. The list of team slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with push access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of app slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of app `slug`s with push access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "required_linear_history",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "allow_force_pushes": {
+ "type": "boolean or null",
+ "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\" in the GitHub Help documentation.\"
",
+ "nullable": true,
+ "name": "allow_force_pushes",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.\"",
+ "childParamsGroups": []
+ },
+ "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\" in the GitHub Help documentation.
",
+ "name": "allow_deletions",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.luke-cage-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "update-branch-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote: Passing new arrays of users and teams replaces their previous values.
\nNote: The list of users, apps, and teams in total is limited to 100 items.
",
+ "bodyParameters": [
+ {
+ "type": "object or null",
+ "description": "Required. Require status checks to pass before merging. Set to null to disable.
",
+ "nullable": true,
+ "properties": {
+ "strict": {
+ "type": "boolean",
+ "description": "Required. Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ "contexts": {
+ "type": "array of strings",
+ "description": "Required. The list of status checks to require in order to merge into this branch
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of status checks to require in order to merge into this branch",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "strict",
+ "contexts"
+ ],
+ "name": "required_status_checks",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Require status checks to pass before merging. Set to `null` to disable.",
+ "childParamsGroups": [
+ {
+ "parentName": "required_status_checks",
+ "parentType": "object",
+ "id": "required_status_checks-object",
+ "params": [
+ {
+ "type": "boolean",
+ "description": "Required. Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Required. The list of status checks to require in order to merge into this branch
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of status checks to require in order to merge into this branch",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "boolean or null",
+ "description": "Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
",
+ "nullable": true,
+ "name": "enforce_admins",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object or null",
+ "description": "Required. 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 of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ },
+ "name": "dismissal_restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean",
+ "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
",
+ "name": "dismiss_stale_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
+ "childParamsGroups": []
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until code owners review them.
",
+ "name": "require_code_owner_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.",
+ "childParamsGroups": []
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "required_pull_request_reviews",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.",
+ "childParamsGroups": [
+ {
+ "parentName": "required_pull_request_reviews",
+ "parentType": "object",
+ "id": "required_pull_request_reviews-object",
+ "params": [
+ {
+ "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 of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ },
+ "name": "dismissal_restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "boolean",
+ "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
",
+ "name": "dismiss_stale_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until code owners review them.
",
+ "name": "require_code_owner_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "object or null",
+ "description": "Required. 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 of strings",
+ "description": "Required. The list of user logins with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with push access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "Required. The list of team slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with push access",
+ "childParamsGroups": []
+ },
+ "apps": {
+ "type": "array of strings",
+ "description": "The list of app slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of app `slug`s with push access",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "users",
+ "teams"
+ ],
+ "name": "restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "restrictions",
+ "parentType": "object",
+ "id": "restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "Required. The list of user logins with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with push access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Required. The list of team slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with push access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of app slugs with push access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of app `slug`s with push access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "required_linear_history",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean or null",
+ "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\" in the GitHub Help documentation.\"
",
+ "nullable": true,
+ "name": "allow_force_pushes",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.\"",
+ "childParamsGroups": []
+ },
+ {
+ "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\" in the GitHub Help documentation.
",
+ "name": "allow_deletions",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Delete branch protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-branch-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "delete-branch-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get admin branch protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-admin-branch-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-admin-branch-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\n \"enabled\": true\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Set admin branch protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-admin-branch-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "set-admin-branch-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\n \"enabled\": true\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/enforce_admins
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Delete admin branch protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-admin-branch-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "delete-admin-branch-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "No content"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get pull request review protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-pull-request-review-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.luke-cage-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-pull-request-review-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews \\\n -d '{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update pull request review protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-pull-request-review-protection"
+ },
+ "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 of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ },
+ "name": "dismissal_restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "dismiss_stale_reviews": {
+ "type": "boolean",
+ "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
",
+ "name": "dismiss_stale_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
+ "childParamsGroups": []
+ },
+ "require_code_owner_reviews": {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until code owners have reviewed.
",
+ "name": "require_code_owner_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.",
+ "childParamsGroups": []
+ },
+ "required_approving_review_count": {
+ "type": "integer",
+ "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.luke-cage-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "update-pull-request-review-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\n \"dismissal_restrictions\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\n \"users_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\n \"users\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ]\n },\n \"dismiss_stale_reviews\": true,\n \"require_code_owner_reviews\": true,\n \"required_approving_review_count\": 2\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "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 of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ "teams": {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ },
+ "name": "dismissal_restrictions",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "dismissal_restrictions",
+ "parentType": "object",
+ "id": "dismissal_restrictions-object",
+ "params": [
+ {
+ "type": "array of strings",
+ "description": "The list of user logins with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of user `login`s with dismissal access",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of team slugs with dismissal access
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of team `slug`s with dismissal access",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "boolean",
+ "description": "Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.
",
+ "name": "dismiss_stale_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Blocks merging pull requests until code owners have reviewed.
",
+ "name": "require_code_owner_reviews",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.
",
+ "name": "required_approving_review_count",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_pull_request_reviews
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Delete pull request review protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-pull-request-review-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "delete-pull-request-review-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "No content"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get commit signature protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-commit-signature-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "zzzax",
+ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.zzzax-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-commit-signature-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
\nNote: You must enable branch protection to require signed commits.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\n \"enabled\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create commit signature protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-commit-signature-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "zzzax",
+ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.zzzax-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "create-commit-signature-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\n \"enabled\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete commit signature protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-commit-signature-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "zzzax",
+ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.zzzax-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "delete-commit-signature-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "No content"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get status checks protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-status-checks-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-status-checks-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-status-checks-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\n \"strict\": true,\n \"contexts\": [\n \"continuous-integration/travis-ci\"\n ],\n \"contexts_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks \\\n -d '{\"strict\":true}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n strict: true\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n strict: true\n})\n
"
+ }
+ ],
+ "summary": "Update status check protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-status-check-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-status-check-potection"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "strict": {
+ "type": "boolean",
+ "description": "Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ "contexts": {
+ "type": "array of strings",
+ "description": "The list of status checks to require in order to merge into this branch
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of status checks to require in order to merge into this branch",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "update-status-check-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
",
+ "bodyParameters": [
+ {
+ "type": "boolean",
+ "description": "Require branches to be up to date before merging.
",
+ "name": "strict",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Require branches to be up to date before merging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The list of status checks to require in order to merge into this branch
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The list of status checks to require in order to merge into this branch",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\n \"strict\": true,\n \"contexts\": [\n \"continuous-integration/travis-ci\"\n ],\n \"contexts_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Remove status check protection",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-status-check-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-status-check-protection"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "remove-status-check-protection",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "No content"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get all status check contexts",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-all-status-check-contexts"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-all-status-check-contexts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response",
+ "payload": "[\n \"continuous-integration/travis-ci\"\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: {\n contexts: [\n 'contexts'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: {\n contexts: [\n 'contexts'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add status check contexts",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-status-check-contexts"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array of strings",
+ "description": "Required. contexts parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "contexts parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "contexts",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "add-status-check-contexts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. contexts parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "contexts parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response",
+ "payload": "[\n \"continuous-integration/travis-ci\",\n \"continuous-integration/jenkins\"\n]\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: {\n contexts: [\n 'contexts'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: {\n contexts: [\n 'contexts'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Set status check contexts",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-status-check-contexts"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array of strings",
+ "description": "Required. contexts parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "contexts parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "contexts",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "set-status-check-contexts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. contexts parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "contexts parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response",
+ "payload": "[\n \"continuous-integration/travis-ci\"\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_status_checks/contexts \\\n -d '{\"contexts\":{\"contexts\":[\"contexts\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: {\n contexts: [\n 'contexts'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: {\n contexts: [\n 'contexts'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove status check contexts",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-status-check-contexts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-status-check-contexts"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array of strings",
+ "description": "Required. contexts parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "contexts parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "contexts",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "remove-status-check-contexts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. contexts parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "contexts parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response",
+ "payload": "[\n \"continuous-integration/travis-ci\"\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-access-restrictions"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\n \"users_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\n \"apps_url\": \"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\n \"users\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ],\n \"apps\": [\n {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Delete access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-access-restrictions"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "delete-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "No content"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get apps with access to the protected branch",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-apps-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-apps-with-access-to-the-protected-branch"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-apps-with-access-to-the-protected-branch",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n apps: {\n apps: [\n 'apps'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n apps: {\n apps: [\n 'apps'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add app access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-app-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-app-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "apps": {
+ "type": "array of strings",
+ "description": "Required. apps parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "apps parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "apps"
+ ],
+ "example": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "apps",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "add-app-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. apps parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "apps parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n apps: {\n apps: [\n 'apps'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n apps: {\n apps: [\n 'apps'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Set app access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-app-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-app-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "apps": {
+ "type": "array of strings",
+ "description": "Required. apps parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "apps parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "apps"
+ ],
+ "example": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "apps",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "set-app-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. apps parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "apps parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps \\\n -d '{\"apps\":{\"apps\":[\"apps\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n apps: {\n apps: [\n 'apps'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n apps: {\n apps: [\n 'apps'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove app access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-app-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-app-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "apps": {
+ "type": "array of strings",
+ "description": "Required. apps parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "apps parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "apps"
+ ],
+ "example": {
+ "apps": [
+ "my-app"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "apps",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "remove-app-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. apps parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "apps",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "apps parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get teams with access to the protected branch",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-teams-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-teams-with-access-to-the-protected-branch"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-teams-with-access-to-the-protected-branch",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: {\n teams: [\n 'teams'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: {\n teams: [\n 'teams'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add team access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-team-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array of strings",
+ "description": "Required. teams parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "teams parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "teams",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "add-team-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. teams parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "teams parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: {\n teams: [\n 'teams'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: {\n teams: [\n 'teams'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Set team access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-team-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array of strings",
+ "description": "Required. teams parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "teams parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "teams",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "set-team-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. teams parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "teams parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams \\\n -d '{\"teams\":{\"teams\":[\"teams\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: {\n teams: [\n 'teams'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: {\n teams: [\n 'teams'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove team access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-team-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array of strings",
+ "description": "Required. teams parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "teams parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "teams",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "remove-team-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. teams parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "teams",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "teams parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})\n
"
+ }
+ ],
+ "summary": "Get users with access to the protected branch",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-users-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-users-with-access-to-the-protected-branch"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "get-users-with-access-to-the-protected-branch",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the people who have push access to this branch.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: {\n users: [\n 'users'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: {\n users: [\n 'users'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add user access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-user-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array of strings",
+ "description": "Required. users parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "users parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "users",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "add-user-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. users parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "users parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: {\n users: [\n 'users'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: {\n users: [\n 'users'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Set user access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-user-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array of strings",
+ "description": "Required. users parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "users parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "users",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "set-user-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. users parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "users parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "branch+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/users \\\n -d '{\"users\":{\"users\":[\"users\"]}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: {\n users: [\n 'users'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: {\n users: [\n 'users'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove user access restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-user-access-restrictions"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array of strings",
+ "description": "Required. users parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "users parameter",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "requestBodyParameterName": "users",
+ "category": "repos",
+ "subcategory": "branches"
+ },
+ "slug": "remove-user-access-restrictions",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "branches",
+ "subcategoryLabel": "Branches",
+ "notes": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. users parameter
",
+ "items": {
+ "type": "string"
+ },
+ "name": "users",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "users parameter",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/check-runs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n head_sha: 'head_sha',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n head_sha: 'head_sha',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a check run",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#create-a-check-run"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the check. For example, \"code-coverage\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the check. For example, \"code-coverage\".",
+ "childParamsGroups": []
+ },
+ "head_sha": {
+ "type": "string",
+ "description": "Required. The SHA of the commit.
",
+ "name": "head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the commit.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "default": "queued",
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ "started_at": {
+ "type": "string",
+ "description": "The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "started_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: 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"
+ ],
+ "name": "conclusion",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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`.",
+ "childParamsGroups": []
+ },
+ "completed_at": {
+ "type": "string",
+ "description": "The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "completed_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "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 description.
",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The title of the check run.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the check run.",
+ "childParamsGroups": []
+ },
+ "summary": {
+ "type": "string",
+ "description": "Required. The summary of the check run. This parameter supports Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The summary of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ "text": {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "title",
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#output-object) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The title of the check run.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the check run.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The summary of the check run. This parameter supports Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The summary of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "actions": {
+ "type": "array of objects",
+ "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\" To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ },
+ "name": "actions",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs-and-requested-actions).\"",
+ "childParamsGroups": [
+ {
+ "parentName": "actions",
+ "parentType": "items",
+ "id": "actions-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "create-a-check-run",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "descriptionHTML": "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.
\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.
\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response for in_progress conclusion",
+ "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme Report\",\n \"summary\": \"\",\n \"text\": \"\",\n \"annotations_count\": 1,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response for completed conclusion",
+ "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"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.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the check. For example, \"code-coverage\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the check. For example, \"code-coverage\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA of the commit.
",
+ "name": "head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the commit.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "default": "queued",
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "started_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: 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"
+ ],
+ "name": "conclusion",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "completed_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "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 description.
",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The title of the check run.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the check run.",
+ "childParamsGroups": []
+ },
+ "summary": {
+ "type": "string",
+ "description": "Required. The summary of the check run. This parameter supports Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The summary of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ "text": {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "title",
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#output-object) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The title of the check run.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the check run.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The summary of the check run. This parameter supports Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The summary of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The details of the check run. This parameter supports Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details about how to use this parameter.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#images-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\" To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ },
+ "name": "actions",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs-and-requested-actions).\"",
+ "childParamsGroups": [
+ {
+ "parentName": "actions",
+ "parentType": "items",
+ "id": "actions-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_run_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a check run",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#get-a-check-run"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "get-a-check-run",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nGets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"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.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_run_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a check run",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the check. For example, \"code-coverage\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the check. For example, \"code-coverage\".",
+ "childParamsGroups": []
+ },
+ "details_url": {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL of the integrator's site that has the full details of the check.",
+ "childParamsGroups": []
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ "started_at": {
+ "type": "string",
+ "description": "This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "started_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: 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"
+ ],
+ "name": "conclusion",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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`.",
+ "childParamsGroups": []
+ },
+ "completed_at": {
+ "type": "string",
+ "description": "The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "completed_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "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 description.
",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required**.",
+ "childParamsGroups": []
+ },
+ "summary": {
+ "type": "string",
+ "description": "Required. Can contain Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ "text": {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#output-object-1) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required**.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. Can contain Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "actions": {
+ "type": "array of objects",
+ "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 description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ },
+ "name": "actions",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs-and-requested-actions).\"",
+ "childParamsGroups": [
+ {
+ "parentName": "actions",
+ "parentType": "items",
+ "id": "actions-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "update-a-check-run",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "descriptionHTML": "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.
\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"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.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The name of the check. For example, \"code-coverage\".
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the check. For example, \"code-coverage\".",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check.
",
+ "name": "details_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL of the integrator's site that has the full details of the check.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system.
",
+ "name": "external_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the run on the integrator's system.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "started_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The current status. Can be one of queued, in_progress, or completed.
",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "name": "status",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: 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"
+ ],
+ "name": "conclusion",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "completed_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "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 description.
",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required**.",
+ "childParamsGroups": []
+ },
+ "summary": {
+ "type": "string",
+ "description": "Required. Can contain Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ "text": {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ "annotations": {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "images": {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "summary"
+ ],
+ "name": "output",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#output-object-1) description.",
+ "childParamsGroups": [
+ {
+ "parentName": "output",
+ "parentType": "object",
+ "id": "output-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required**.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. Can contain Markdown.
",
+ "name": "summary",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Can contain Markdown.
",
+ "name": "text",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Can contain Markdown.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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 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\". See the annotations object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ },
+ "name": "annotations",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ "image_url": {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ },
+ "name": "images",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#annotations-object-1) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "parentName": "annotations",
+ "parentType": "items",
+ "id": "annotations-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The path of the file to add an annotation to. For example, assets/css/main.css.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The start line of the annotation.
",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The start line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Required. The end line of the annotation.
",
+ "name": "end_line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The end line of the annotation.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "start_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "end_column",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The level of the annotation. Can be one of notice, warning, or failure.
",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ],
+ "name": "annotation_level",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB.
",
+ "name": "raw_details",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Details about this annotation. The maximum size is 64 KB.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "parentName": "images",
+ "parentType": "items",
+ "id": "images-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The alternative text for the image.
",
+ "name": "alt",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The alternative text for the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The full URL of the image.
",
+ "name": "image_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the image.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short image description.
",
+ "name": "caption",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short image description.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of objects",
+ "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 description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ "identifier": {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ },
+ "name": "actions",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs-and-requested-actions).\"",
+ "childParamsGroups": [
+ {
+ "parentName": "actions",
+ "parentType": "items",
+ "id": "actions-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A short explanation of what this action would do. The maximum size is 40 characters.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short explanation of what this action would do. The maximum size is 40 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. A reference for the action on the integrator's system. The maximum size is 20 characters.
",
+ "name": "identifier",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_run_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List check run annotations",
+ "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-annotations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#list-check-run-annotations"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "list-check-run-annotations",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"path\": \"README.md\",\n \"start_line\": 2,\n \"end_line\": 2,\n \"start_column\": 5,\n \"end_column\": 10,\n \"annotation_level\": \"warning\",\n \"title\": \"Spell Checker\",\n \"message\": \"Check your spelling for 'banaas'.\",\n \"raw_details\": \"Do you mean 'bananas' or 'banana'?\",\n \"blob_href\": \"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/check-suites",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/check-suites', {\n owner: 'octocat',\n repo: 'hello-world',\n head_sha: 'head_sha',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/check-suites', {\n owner: 'octocat',\n repo: 'hello-world',\n head_sha: 'head_sha',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a check suite",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/create-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#create-a-check-suite"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "head_sha": {
+ "type": "string",
+ "description": "Required. The sha of the head commit.
",
+ "name": "head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The sha of the head commit.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "head_sha"
+ ]
+ },
+ "example": {
+ "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "suites"
+ },
+ "slug": "create-a-check-suite",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "suites",
+ "subcategoryLabel": "Suites",
+ "notes": [],
+ "descriptionHTML": "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.
\nBy default, check suites are automatically created when you create a check run. 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\". Your GitHub App must have the checks:write permission to create check suites.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The sha of the head commit.
",
+ "name": "head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The sha of the head commit.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": \"octocat/template-repo\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/check-suites/preferences",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/check-suites/preferences', {\n owner: 'octocat',\n repo: 'hello-world',\n auto_trigger_checks: [\n {\n app_id: 42,\n setting: true\n }\n ],\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/check-suites/preferences', {\n owner: 'octocat',\n repo: 'hello-world',\n auto_trigger_checks: [\n {\n app_id: 42,\n setting: true\n }\n ],\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update repository preferences for check suites",
+ "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/set-suites-preferences",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#update-repository-preferences-for-check-suites"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "auto_trigger_checks": {
+ "type": "array of objects",
+ "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer",
+ "description": "Required. The id of the GitHub App.
",
+ "name": "app_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The `id` of the GitHub App.",
+ "childParamsGroups": []
+ },
+ "setting": {
+ "type": "boolean",
+ "description": "Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
",
+ "default": true,
+ "name": "setting",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "app_id",
+ "setting"
+ ]
+ },
+ "name": "auto_trigger_checks",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#auto_trigger_checks-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "auto_trigger_checks",
+ "parentType": "items",
+ "id": "auto_trigger_checks-items",
+ "params": [
+ {
+ "type": "integer",
+ "description": "Required. The id of the GitHub App.
",
+ "name": "app_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The `id` of the GitHub App.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
",
+ "default": true,
+ "name": "setting",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "example": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "suites"
+ },
+ "slug": "update-repository-preferences-for-check-suites",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "suites",
+ "subcategoryLabel": "Suites",
+ "notes": [],
+ "descriptionHTML": "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. You must have admin permissions in the repository to set preferences for check suites.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"preferences\": {\n \"auto_trigger_checks\": [\n {\n \"app_id\": 2,\n \"setting\": true\n },\n {\n \"app_id\": 4,\n \"setting\": false\n }\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"http://choosealicense.com/licenses/mit/\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n }\n}\n
"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "array of objects",
+ "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.
",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer",
+ "description": "Required. The id of the GitHub App.
",
+ "name": "app_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The `id` of the GitHub App.",
+ "childParamsGroups": []
+ },
+ "setting": {
+ "type": "boolean",
+ "description": "Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
",
+ "default": true,
+ "name": "setting",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "app_id",
+ "setting"
+ ]
+ },
+ "name": "auto_trigger_checks",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@2.19/rest/reference/checks#auto_trigger_checks-object) description for details.",
+ "childParamsGroups": [
+ {
+ "parentName": "auto_trigger_checks",
+ "parentType": "items",
+ "id": "auto_trigger_checks-items",
+ "params": [
+ {
+ "type": "integer",
+ "description": "Required. The id of the GitHub App.
",
+ "name": "app_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The `id` of the GitHub App.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.
",
+ "default": true,
+ "name": "setting",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_suite_id",
+ "description": "check_suite_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_suite_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a check suite",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/get-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#get-a-check-suite"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "suites"
+ },
+ "slug": "get-a-check-suite",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "suites",
+ "subcategoryLabel": "Suites",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nGets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": \"octocat/template-repo\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_suite_id",
+ "description": "check_suite_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_suite_id parameter
"
+ },
+ {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Returns check runs with the specified name.
"
+ },
+ {
+ "name": "status",
+ "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "descriptionHTML": "Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
"
+ },
+ {
+ "name": "filter",
+ "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "latest",
+ "all"
+ ],
+ "default": "latest"
+ },
+ "descriptionHTML": "Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List check runs in a check suite",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-for-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#list-check-runs-in-a-check-suite"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "list-check-runs-in-a-check-suite",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nLists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"check_runs\": [\n {\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"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.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_suite_id",
+ "description": "check_suite_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_suite_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42,\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Rerequest a check suite",
+ "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#rerequest-a-check-suite"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "suites"
+ },
+ "slug": "rerequest-a-check-suite",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "suites",
+ "subcategoryLabel": "Suites",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
\nTo rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/collaborators",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filter collaborators returned by their affiliation. Can be one of:
\n* outside: All outside collaborators of an organization-owned repository.
\n* direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/collaborators', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/collaborators', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository collaborators",
+ "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-repository-collaborators"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "collaborators"
+ },
+ "slug": "list-repository-collaborators",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nTeam members will include the members of child teams.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"permissions\": {\n \"pull\": true,\n \"push\": true,\n \"admin\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/collaborators/{username}', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/collaborators/{username}', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Check if a user is a repository collaborator",
+ "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/check-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#check-if-a-user-is-a-repository-collaborator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "collaborators"
+ },
+ "slug": "check-if-a-user-is-a-repository-collaborator",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if user is a collaborator"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if user is not a collaborator"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nTeam members will include the members of child teams.
"
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/collaborators/{username}', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username',\n permission: 'permission'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/collaborators/{username}', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username',\n permission: 'permission'\n})\n
"
+ }
+ ],
+ "summary": "Add a repository collaborator",
+ "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-a-repository-collaborator"
+ },
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "permissions": {
+ "type": "string",
+ "example": "\"push\"",
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "collaborators"
+ },
+ "slug": "add-a-repository-collaborator",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nFor more information the permission levels, see \"Repository permission levels for an organization\".
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
",
+ "bodyParameters": [
+ {
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"push\"",
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response when a new invitation is created",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response when person is already a collaborator"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/collaborators/{username}', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/collaborators/{username}', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove a repository collaborator",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-a-repository-collaborator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "collaborators"
+ },
+ "slug": "remove-a-repository-collaborator",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/collaborators/USERNAME/permission
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/collaborators/{username}/permission', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/collaborators/{username}/permission', {\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get repository permissions for a user",
+ "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-collaborator-permission-level",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-repository-permissions-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "collaborators"
+ },
+ "slug": "get-repository-permissions-for-a-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "collaborators",
+ "subcategoryLabel": "Collaborators",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has admin permissions",
+ "payload": "{\n \"permission\": \"admin\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List commit comments for a repository",
+ "description": "Commit Comments use [these custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/).\n\nComments are ordered by ascending ID.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commit-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commit-comments-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "comments"
+ },
+ "slug": "list-commit-comments-for-a-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/comments/1\",\n \"id\": 1,\n \"node_id\": \"MDEzOkNvbW1pdENvbW1lbnQx\",\n \"body\": \"Great stuff\",\n \"path\": \"file1.txt\",\n \"position\": 4,\n \"line\": 14,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a commit comment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-commit-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "comments"
+ },
+ "slug": "get-a-commit-comment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/comments/1\",\n \"id\": 1,\n \"node_id\": \"MDEzOkNvbW1pdENvbW1lbnQx\",\n \"body\": \"Great stuff\",\n \"path\": \"file1.txt\",\n \"position\": 4,\n \"line\": 14,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author_association\": \"collaborator\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update a commit comment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-a-commit-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The contents of the comment
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Nice change"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "comments"
+ },
+ "slug": "update-a-commit-comment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The contents of the comment
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/comments/1\",\n \"id\": 1,\n \"node_id\": \"MDEzOkNvbW1pdENvbW1lbnQx\",\n \"body\": \"Nice change\",\n \"path\": \"file1.txt\",\n \"position\": 4,\n \"line\": 14,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author_association\": \"collaborator\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a commit comment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-commit-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "comments"
+ },
+ "slug": "delete-a-commit-comment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a commit comment",
+ "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#list-reactions-for-a-commit-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-a-commit-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a commit comment.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a commit comment",
+ "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#create-reaction-for-a-commit-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the commit comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the commit comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-a-commit-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the commit comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the commit comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
"
+ },
+ {
+ "name": "path",
+ "description": "Only commits containing this file path will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only commits containing this file path will be returned.
"
+ },
+ {
+ "name": "author",
+ "description": "GitHub login or email address by which to filter by commit author.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "GitHub login or email address by which to filter by commit author.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "until",
+ "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List commits",
+ "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commits"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "commits"
+ },
+ "slug": "list-commits",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"support@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"support@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "commit_sha+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/branches-where-head
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n mediaType: {\n previews: [\n 'groot'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n mediaType: {\n previews: [\n 'groot'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List branches for HEAD commit",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-branches-for-head-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-branches-for-head-commit"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "groot",
+ "note": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.groot-preview+json\n```",
+ "html": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.groot-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "commits"
+ },
+ "slug": "list-branches-for-head-commit",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"name\": \"branch_5\",\n \"commit\": {\n \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n },\n \"protected\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "commit_sha+ parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})\n
"
+ }
+ ],
+ "summary": "List commit comments",
+ "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-comments-for-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commit-comments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "comments"
+ },
+ "slug": "list-commit-comments",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/comments/1\",\n \"id\": 1,\n \"node_id\": \"MDEzOkNvbW1pdENvbW1lbnQx\",\n \"body\": \"Great stuff\",\n \"path\": \"file1.txt\",\n \"position\": 4,\n \"line\": 14,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "commit_sha+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/commits/{commit_sha}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/commits/{commit_sha}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a commit comment",
+ "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-commit-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ },
+ "path": {
+ "type": "string",
+ "description": "Relative path of the file to comment on.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Relative path of the file to comment on.",
+ "childParamsGroups": []
+ },
+ "position": {
+ "type": "integer",
+ "description": "Line index in the diff to comment on.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Line index in the diff to comment on.",
+ "childParamsGroups": []
+ },
+ "line": {
+ "type": "integer",
+ "description": "Deprecated. Use position parameter instead. Line number in the file to comment on.
",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "comments"
+ },
+ "slug": "create-a-commit-comment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "Create a comment for a commit using its :commit_sha.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Relative path of the file to comment on.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Relative path of the file to comment on.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Line index in the diff to comment on.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "Line index in the diff to comment on.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "Deprecated. Use position parameter instead. Line number in the file to comment on.
",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/comments/1\",\n \"id\": 1,\n \"node_id\": \"MDEzOkNvbW1pdENvbW1lbnQx\",\n \"body\": \"Great stuff\",\n \"path\": \"file1.txt\",\n \"position\": 4,\n \"line\": 14,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author_association\": \"collaborator\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "commit_sha+ parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.groot-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/COMMIT_SHA/pulls
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n mediaType: {\n previews: [\n 'groot'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n mediaType: {\n previews: [\n 'groot'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List pull requests associated with a commit",
+ "description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests) endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pull-requests-associated-with-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-pull-requests-associated-with-a-commit"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "groot",
+ "note": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.groot-preview+json\n```",
+ "html": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.groot-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "commits"
+ },
+ "slug": "list-pull-requests-associated-with-a-commit",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Get a commit",
+ "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nYou can pass the appropriate [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-commit"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "commits"
+ },
+ "slug": "get-a-commit",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
\nNote: 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.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
\nTo return only the SHA-1 hash of the commit reference, you can provide the sha custom media type 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.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ],\n \"stats\": {\n \"additions\": 104,\n \"deletions\": 4,\n \"total\": 108\n },\n \"files\": [\n {\n \"filename\": \"file1.txt\",\n \"additions\": 10,\n \"deletions\": 2,\n \"changes\": 12,\n \"status\": \"modified\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\n \"patch\": \"@@ -29,7 +29,7 @@\\n.....\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-runs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ },
+ {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Returns check runs with the specified name.
"
+ },
+ {
+ "name": "status",
+ "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "descriptionHTML": "Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
"
+ },
+ {
+ "name": "filter",
+ "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "latest",
+ "all"
+ ],
+ "default": "latest"
+ },
+ "descriptionHTML": "Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-runs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List check runs for a Git reference",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#list-check-runs-for-a-git-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "list-check-runs-for-a-git-reference",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nLists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"check_runs\": [\n {\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"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.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{ref}/check-suites",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ },
+ {
+ "name": "app_id",
+ "description": "Filters check suites by GitHub App `id`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "example": 1,
+ "descriptionHTML": "Filters check suites by GitHub App id.
"
+ },
+ {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Returns check runs with the specified name.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.antiope-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/check-suites
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/check-suites', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/check-suites', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n mediaType: {\n previews: [\n 'antiope'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List check suites for a Git reference",
+ "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-suites-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/checks#list-check-suites-for-a-git-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```",
+ "html": "The Checks API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.antiope-preview+json
"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "suites"
+ },
+ "slug": "list-check-suites-for-a-git-reference",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "suites",
+ "subcategoryLabel": "Suites",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nLists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"check_suites\": [\n {\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/status",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/status
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/status', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/status', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Get the combined status for a specific reference",
+ "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-combined-status-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-the-combined-status-for-a-specific-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statuses"
+ },
+ "slug": "get-the-combined-status-for-a-specific-reference",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statuses",
+ "subcategoryLabel": "Statuses",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThe most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.
\nAdditionally, a combined state is returned. The state is one of:
\n\n- failure if any of the contexts report as
error or failure \n- pending if there are no statuses or a context is
pending \n- success if the latest status for all contexts is
success \n
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"state\": \"success\",\n \"statuses\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"id\": 1,\n \"node_id\": \"MDY6U3RhdHVzMQ==\",\n \"state\": \"success\",\n \"description\": \"Build has completed successfully\",\n \"target_url\": \"https://ci.example.com/1000/output\",\n \"context\": \"continuous-integration/jenkins\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\"\n },\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"id\": 2,\n \"node_id\": \"MDY6U3RhdHVzMg==\",\n \"state\": \"success\",\n \"description\": \"Testing has completed successfully\",\n \"target_url\": \"https://ci.example.com/2000/output\",\n \"context\": \"security/brakeman\",\n \"created_at\": \"2012-08-20T01:19:13Z\",\n \"updated_at\": \"2012-08-20T01:19:13Z\"\n }\n ],\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"total_count\": 2,\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/commits/REF/statuses
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/commits/{ref}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "List commit statuses for a reference",
+ "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commit-statuses-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commit-statuses-for-a-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statuses"
+ },
+ "slug": "list-commit-statuses-for-a-reference",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statuses",
+ "subcategoryLabel": "Statuses",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"id\": 1,\n \"node_id\": \"MDY6U3RhdHVzMQ==\",\n \"state\": \"success\",\n \"description\": \"Build has completed successfully\",\n \"target_url\": \"https://ci.example.com/1000/output\",\n \"context\": \"continuous-integration/jenkins\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/community/code_of_conduct",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/community/code_of_conduct",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/community/code_of_conduct
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/community/code_of_conduct', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'scarlet-witch'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/community/code_of_conduct', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'scarlet-witch'\n ]\n }\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.19/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```",
+ "html": "The Codes of Conduct API is currently available for developers to preview.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.scarlet-witch-preview+json
"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ },
+ "slug": "get-the-code-of-conduct-for-a-repository",
+ "category": "codes-of-conduct",
+ "categoryLabel": "Codes of conduct",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This method returns the contents of the repository's code of conduct file, if one is detected.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"key\": \"contributor_covenant\",\n \"name\": \"Contributor Covenant\",\n \"url\": \"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\n \"body\": \"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include=>\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include=>\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\n \"html_url\": \"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/compare/{base}...{head}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "base",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "head",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/compare/BASE...HEAD
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/compare/{base}...{head}', {\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/compare/{base}...{head}', {\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})\n
"
+ }
+ ],
+ "summary": "Compare two commits",
+ "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commits) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/compare-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#compare-two-commits"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "commits"
+ },
+ "slug": "compare-two-commits",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 <USERNAME>:branch.
\nThe response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
\nWorking with large comparisons
\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the List commits to enumerate all commits in the range.
\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\n \"html_url\": \"https://github.com/octocat/Hello-World/compare/master...topic\",\n \"permalink_url\": \"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\n \"base_commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n },\n \"merge_base_commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n },\n \"status\": \"behind\",\n \"ahead_by\": 1,\n \"behind_by\": 2,\n \"total_commits\": 1,\n \"commits\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"sha\": \"bbcd538c8e72b8c175046e27cc8f907076331401\",\n \"filename\": \"file1.txt\",\n \"status\": \"added\",\n \"additions\": 103,\n \"deletions\": 21,\n \"changes\": 124,\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"patch\": \"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/contents/{path}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "path",
+ "description": "path+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "path+ parameter
"
+ },
+ {
+ "name": "ref",
+ "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path'\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@2.19/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@2.19/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-content",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-repository-content"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "get-repository-content",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nFiles and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\n\n- To get a repository's contents recursively, you can recursively get the tree.
\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.
\n- This API supports files up to 1 megabyte in size.
\n
\n\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\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\n\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\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\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.
\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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a file",
+ "payload": "{\n \"type\": \"file\",\n \"encoding\": \"base64\",\n \"size\": 5362,\n \"name\": \"README.md\",\n \"path\": \"README.md\",\n \"content\": \"encoded content ...\",\n \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a directory",
+ "payload": "[\n {\n \"type\": \"file\",\n \"size\": 625,\n \"name\": \"octokit.rb\",\n \"path\": \"lib/octokit.rb\",\n \"sha\": \"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"\n }\n },\n {\n \"type\": \"dir\",\n \"size\": 0,\n \"name\": \"octokit\",\n \"path\": \"lib/octokit\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\n \"download_url\": null,\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"html\": \"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a symlink",
+ "payload": "{\n \"type\": \"symlink\",\n \"target\": \"/path/to/symlink/target\",\n \"size\": 23,\n \"name\": \"some-symlink\",\n \"path\": \"bin/some-symlink\",\n \"sha\": \"452a98979c88e093d682cab404a3ec82babebb48\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if content is a submodule",
+ "payload": "{\n \"type\": \"submodule\",\n \"submodule_git_url\": \"git://github.com/jquery/qunit.git\",\n \"size\": 0,\n \"name\": \"qunit\",\n \"path\": \"test/qunit\",\n \"sha\": \"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"url\": \"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\n \"git_url\": \"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"html_url\": \"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"download_url\": null,\n \"_links\": {\n \"git\": \"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\n \"self\": \"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\n \"html\": \"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Found"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/contents/{path}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "path",
+ "description": "path+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "path+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n content: 'content'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n content: 'content'\n})\n
"
+ }
+ ],
+ "summary": "Create or update file contents",
+ "description": "Creates a new file or replaces an existing file in a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-or-update-file-contents",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-or-update-file-contents"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ "content": {
+ "type": "string",
+ "description": "Required. The new file content, using Base64 encoding.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new file content, using Base64 encoding.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "Required if you are updating a file. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ "branch": {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ "committer": {
+ "type": "object",
+ "description": "The person that committed the file. Default: the authenticated user.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The person that committed the file. Default: the authenticated user.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "create-or-update-file-contents",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "descriptionHTML": "Creates a new file or replaces an existing file in a repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Example for updating a file",
+ "payload": "{\n \"content\": {\n \"name\": \"hello.txt\",\n \"path\": \"notes/hello.txt\",\n \"sha\": \"a56507ed892d05a37c6d6128c260937ea4d287bd\",\n \"size\": 9,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"html_url\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\n \"git_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\n \"download_url\": \"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\n \"type\": \"file\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"git\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\n \"html\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"\n }\n },\n \"commit\": {\n \"sha\": \"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\n \"node_id\": \"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\n \"sha\": \"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\n \"sha\": \"da5a433788da5c255edad7979b328b67d79f53f6\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Example for creating a file",
+ "payload": "{\n \"content\": {\n \"name\": \"hello.txt\",\n \"path\": \"notes/hello.txt\",\n \"sha\": \"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\n \"size\": 9,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"html_url\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\n \"git_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\n \"download_url\": \"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\n \"type\": \"file\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\n \"git\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\n \"html\": \"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"\n }\n },\n \"commit\": {\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\n \"sha\": \"691272480426f78a0138979dd3ce63b77f706feb\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"sha\": \"1acc419d4d6a9ce985db7be48c6349a0475975b5\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The new file content, using Base64 encoding.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new file content, using Base64 encoding.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required if you are updating a file. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "The person that committed the file. Default: the authenticated user.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The person that committed the file. Default: the authenticated user.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-05T13:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "description": "The author of the file. Default: The committer or the authenticated user if you omit committer.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name",
+ "email"
+ ],
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"2013-01-15T17:13:22+05:00\"",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/contents/{path}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "path",
+ "description": "path+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "path+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contents/PATH \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n sha: 'sha'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/contents/{path}', {\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Delete a file",
+ "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-file",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-file"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "Required. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ "branch": {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the committer.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the author.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "message",
+ "sha"
+ ]
+ },
+ "example": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "delete-a-file",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
\nThe author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
\nYou must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"content\": null,\n \"commit\": {\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\n \"sha\": \"691272480426f78a0138979dd3ce63b77f706feb\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"html_url\": \"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"sha\": \"1acc419d4d6a9ce985db7be48c6349a0475975b5\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The commit message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The blob SHA of the file being replaced.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The blob SHA of the file being replaced.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The branch name. Default: the repository’s default branch (usually master)
",
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The branch name. Default: the repository’s default branch (usually `master`)",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "object containing information about the committer.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the committer.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "description": "object containing information about the author.
",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "object containing information about the author.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/contributors",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "anon",
+ "description": "Set to `1` or `true` to include anonymous contributors in results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Set to 1 or true to include anonymous contributors in results.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/contributors
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository contributors",
+ "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-contributors",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-repository-contributors"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-contributors",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if repository contains content",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"contributions\": 32\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if repository is empty"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "sha",
+ "description": "The SHA recorded at creation time.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The SHA recorded at creation time.
"
+ },
+ {
+ "name": "ref",
+ "description": "The name of the ref. This can be a branch, tag, or SHA.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The name of the ref. This can be a branch, tag, or SHA.
"
+ },
+ {
+ "name": "task",
+ "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The name of the task for the deployment (e.g., deploy or deploy:migrations).
"
+ },
+ {
+ "name": "environment",
+ "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "none"
+ },
+ "descriptionHTML": "The name of the environment that was deployed to (e.g., staging or production).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List deployments",
+ "description": "Simple filtering of deployments is available via query parameters:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-deployments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "list-deployments",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Simple filtering of deployments is available via query parameters:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/deployments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments \\\n -d '{\"ref\":\"ref\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Create a deployment",
+ "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-deployment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Required. The ref to deploy. This can be a branch, tag, or SHA.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.",
+ "childParamsGroups": []
+ },
+ "task": {
+ "type": "string",
+ "description": "Specifies a task to execute (e.g., deploy or deploy:migrations).
",
+ "default": "deploy",
+ "name": "task",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "auto_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
+ "childParamsGroups": []
+ },
+ "required_contexts": {
+ "type": "array of strings",
+ "description": "The status 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"
+ },
+ "name": "required_contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [status](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
+ "childParamsGroups": []
+ },
+ "payload": {
+ "type": "string",
+ "description": "JSON payload with extra information about the deployment.
",
+ "default": "",
+ "name": "payload",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "JSON payload with extra information about the deployment.",
+ "childParamsGroups": []
+ },
+ "environment": {
+ "type": "string",
+ "description": "Name for the target deployment environment (e.g., production, staging, qa).
",
+ "default": "production",
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string or null",
+ "description": "Short description of the deployment.
",
+ "default": "",
+ "nullable": true,
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Short description of the deployment.",
+ "childParamsGroups": []
+ },
+ "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
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": false,
+ "name": "transient_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "production_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "created_at": {
+ "type": "string",
+ "example": "\"1776-07-04T00:00:00.000-07:52\"",
+ "name": "created_at",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "create-a-deployment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
\nThe environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
\nThe auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
\nBy default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
\nThe payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
\nThe task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
\nUsers with repo or repo_deployment scopes can create a deployment for a given ref.
\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\n\n- Auto-merge option is enabled in the repository
\n- Topic branch does not include the latest changes on the base branch, which is
master in the response example \n- There are no merge conflicts
\n
\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\n\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
\n\nThis error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The ref to deploy. This can be a branch, tag, or SHA.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Specifies a task to execute (e.g., deploy or deploy:migrations).
",
+ "default": "deploy",
+ "name": "task",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
",
+ "default": true,
+ "name": "auto_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "The status 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"
+ },
+ "name": "required_contexts",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "The [status](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "JSON payload with extra information about the deployment.
",
+ "default": "",
+ "name": "payload",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "JSON payload with extra information about the deployment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Name for the target deployment environment (e.g., production, staging, qa).
",
+ "default": "production",
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "description": "Short description of the deployment.
",
+ "default": "",
+ "nullable": true,
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Short description of the deployment.",
+ "childParamsGroups": []
+ },
+ {
+ "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
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": false,
+ "name": "transient_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "production_environment",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"1776-07-04T00:00:00.000-07:52\"",
+ "name": "created_at",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Simple example",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Advanced example",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Merged branch response",
+ "payload": "{\n \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Merge conflict response",
+ "payload": "{\n \"message\": \"Conflict merging master into topic-branch\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Failed commit status checks",
+ "payload": "{\n \"message\": \"Conflict: Commit status checks failed for topic-branch.\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a deployment",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-deployment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ },
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "get-a-deployment",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n \"id\": 1,\n \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n \"ref\": \"topic-branch\",\n \"task\": \"deploy\",\n \"payload\": {},\n \"original_environment\": \"staging\",\n \"environment\": \"production\",\n \"description\": \"Deploy request from hubot\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"transient_environment\": false,\n \"production_environment\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List deployment statuses",
+ "description": "Users with pull access can view deployment statuses for a deployment:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployment-statuses",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-deployment-statuses"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```",
+ "html": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.
\nTo access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:
\napplication/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.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "list-deployment-statuses",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with pull access can view deployment statuses for a deployment:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\n \"id\": 1,\n \"node_id\": \"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\n \"state\": \"success\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"description\": \"Deployment finished successfully.\",\n \"environment\": \"production\",\n \"target_url\": \"https://example.com/deployment/42/output\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"deployment_url\": \"https://api.github.com/repos/octocat/example/deployments/42\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"environment_url\": \"https://test-branch.lab.acme.com\",\n \"log_url\": \"https://example.com/deployment/42/output\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses \\\n -d '{\"state\":\"state\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n state: 'state'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n state: 'state'\n})\n
"
+ }
+ ],
+ "summary": "Create a deployment status",
+ "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-deployment-status"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "Required. 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 custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json 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"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
+ "childParamsGroups": []
+ },
+ "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": "",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "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: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "log_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the status. The maximum description length is 140 characters.
",
+ "default": "",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status. The maximum description length is 140 characters.",
+ "childParamsGroups": []
+ },
+ "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 custom media type.
",
+ "enum": [
+ "production",
+ "staging",
+ "qa"
+ ],
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#deployment-statuses) custom media type.",
+ "childParamsGroups": []
+ },
+ "environment_url": {
+ "type": "string",
+ "description": "Sets the URL for accessing your environment. Default: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "environment_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ "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
\nNote: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "auto_inactive",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```",
+ "html": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.
\nTo access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:
\napplication/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.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "create-a-deployment-status",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
\nGitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. 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 custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json 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"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
+ "childParamsGroups": []
+ },
+ {
+ "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": "",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "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: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "log_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the status. The maximum description length is 140 characters.
",
+ "default": "",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status. The maximum description length is 140 characters.",
+ "childParamsGroups": []
+ },
+ {
+ "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 custom media type.
",
+ "enum": [
+ "production",
+ "staging",
+ "qa"
+ ],
+ "name": "environment",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#deployment-statuses) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Sets the URL for accessing your environment. Default: \"\"
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "default": "",
+ "name": "environment_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ },
+ {
+ "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
\nNote: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type.
\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.
",
+ "name": "auto_inactive",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.19/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\n \"id\": 1,\n \"node_id\": \"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\n \"state\": \"success\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"description\": \"Deployment finished successfully.\",\n \"environment\": \"production\",\n \"target_url\": \"https://example.com/deployment/42/output\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"deployment_url\": \"https://api.github.com/repos/octocat/example/deployments/42\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"environment_url\": \"https://test-branch.lab.acme.com\",\n \"log_url\": \"https://example.com/deployment/42/output\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "deployment_id parameter
"
+ },
+ {
+ "name": "status_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/deployments/42/statuses/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n status_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 42,\n status_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a deployment status",
+ "description": "Users with pull access can view a deployment status for a deployment:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-deployment-status"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ },
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```",
+ "html": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.
\nTo access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:
\napplication/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.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```",
+ "html": "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 for full details.
\nTo access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.ant-man-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ },
+ "slug": "get-a-deployment-status",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "deployments",
+ "subcategoryLabel": "Deployments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with pull access can view a deployment status for a deployment:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\n \"id\": 1,\n \"node_id\": \"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\n \"state\": \"success\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"description\": \"Deployment finished successfully.\",\n \"environment\": \"production\",\n \"target_url\": \"https://example.com/deployment/42/output\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"deployment_url\": \"https://api.github.com/repos/octocat/example/deployments/42\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n \"environment_url\": \"https://test-branch.lab.acme.com\",\n \"log_url\": \"https://example.com/deployment/42/output\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository events",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repository-events"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-repository-events",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/forks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "The sort order. Can be either newest, oldest, or stargazers.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List forks",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-forks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "forks"
+ },
+ "slug": "list-forks",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "forks",
+ "subcategoryLabel": "Forks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": true,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/forks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/forks \\\n -d '{\"organization\":\"organization\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world',\n organization: 'organization'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/forks', {\n owner: 'octocat',\n repo: 'hello-world',\n organization: 'organization'\n})\n
"
+ }
+ ],
+ "summary": "Create a fork",
+ "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://github.com/contact) or [GitHub Enterprise Server Premium Support](https://premium.githubsupport.com).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-fork"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "organization": {
+ "type": "string",
+ "description": "Optional parameter to specify the organization name if forking into an organization.
",
+ "name": "organization",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Optional parameter to specify the organization name if forking into an organization.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "forks"
+ },
+ "slug": "create-a-fork",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "forks",
+ "subcategoryLabel": "Forks",
+ "notes": [],
+ "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Enterprise Server Support or GitHub Enterprise Server Premium Support.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Optional parameter to specify the organization name if forking into an organization.
",
+ "name": "organization",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Optional parameter to specify the organization name if forking into an organization.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/blobs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/blobs', {\n owner: 'octocat',\n repo: 'hello-world',\n content: 'content'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/blobs', {\n owner: 'octocat',\n repo: 'hello-world',\n content: 'content'\n})\n
"
+ }
+ ],
+ "summary": "Create a blob",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-blob"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The new blob's content.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blob's content.",
+ "childParamsGroups": []
+ },
+ "encoding": {
+ "type": "string",
+ "description": "The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.
",
+ "default": "utf-8",
+ "name": "encoding",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "blobs"
+ },
+ "slug": "create-a-blob",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "blobs",
+ "subcategoryLabel": "Blobs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The new blob's content.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blob's content.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.
",
+ "default": "utf-8",
+ "name": "encoding",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\n \"sha\": \"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "file_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/blobs/FILE_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/blobs/{file_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n file_sha: 'file_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/blobs/{file_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n file_sha: 'file_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a blob",
+ "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#get-a-blob"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "blobs"
+ },
+ "slug": "get-a-blob",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "blobs",
+ "subcategoryLabel": "Blobs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The content in the response will always be Base64 encoded.
\nNote: This API supports blobs up to 100 megabytes in size.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"content\": \"Q29udGVudCBvZiB0aGUgYmxvYg==\",\n \"encoding\": \"base64\",\n \"url\": \"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\n \"sha\": \"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\n \"size\": 19,\n \"node_id\": \"Q29udGVudCBvZiB0aGUgYmxvYg==\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n message: 'message',\n tree: 'tree'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n message: 'message',\n tree: 'tree'\n})\n
"
+ }
+ ],
+ "summary": "Create a commit",
+ "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-commit"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The commit message
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message",
+ "childParamsGroups": []
+ },
+ "tree": {
+ "type": "string",
+ "description": "Required. The SHA of the tree object this commit points to
",
+ "name": "tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the tree object this commit points to",
+ "childParamsGroups": []
+ },
+ "parents": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "parents",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "signature": {
+ "type": "string",
+ "description": "The PGP signature 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 to create signed commits.
",
+ "name": "signature",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "message",
+ "tree"
+ ]
+ },
+ "example": {
+ "message": "my commit message",
+ "author": {
+ "name": "Mona Octocat",
+ "email": "octocat@github.com",
+ "date": "2008-07-09T16:13:30+12:00"
+ },
+ "parents": [
+ "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
+ ],
+ "tree": "827efc6d56897b048c772eb4087f854f46256132",
+ "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "commits"
+ },
+ "slug": "create-a-commit",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"my commit message\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\n \"sha\": \"827efc6d56897b048c772eb4087f854f46256132\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\n \"sha\": \"7d1b31e74ee336d15cbd21741bc88a537ed063a0\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The commit message
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The commit message",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA of the tree object this commit points to
",
+ "name": "tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the tree object this commit points to",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "parents",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "author",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "author",
+ "parentType": "object",
+ "id": "author-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "committer",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "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.",
+ "childParamsGroups": [
+ {
+ "parentName": "committer",
+ "parentType": "object",
+ "id": "committer-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author (or committer) of the commit",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "string",
+ "description": "The PGP signature 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 to create signed commits.
",
+ "name": "signature",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "commit_sha+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/commits/COMMIT_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/commits/{commit_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/commits/{commit_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a commit",
+ "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#get-a-commit"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "commits"
+ },
+ "slug": "get-a-commit",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "commits",
+ "subcategoryLabel": "Commits",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\n \"author\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"committer\": {\n \"date\": \"2014-11-07T22:01:45Z\",\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\"\n },\n \"message\": \"added readme, because im a good github citizen\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\n \"sha\": \"691272480426f78a0138979dd3ce63b77f706feb\"\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\n \"sha\": \"1acc419d4d6a9ce985db7be48c6349a0475975b5\"\n }\n ],\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/matching-refs/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/matching-refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/matching-refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "List matching references",
+ "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.19/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/list-matching-refs",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#list-matching-references"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "list-matching-references",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
\nWhen you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
\nNote: You need to explicitly request 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\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"ref\": \"refs/heads/feature-a\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"aa218f56b14c9653891f9e74264a383fa43fefbd\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"\n }\n },\n {\n \"ref\": \"refs/heads/feature-b\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/ref/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/ref/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/ref/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Get a reference",
+ "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.19/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#get-a-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "get-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
\nNote: You need to explicitly request 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\".
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"ref\": \"refs/heads/featureA\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"aa218f56b14c9653891f9e74264a383fa43fefbd\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/refs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/refs', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/refs', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Create a reference",
+ "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-reference"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "Required. The SHA1 value for this reference.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value for this reference.",
+ "childParamsGroups": []
+ },
+ "key": {
+ "type": "string",
+ "example": "\"refs/heads/newbranch\"",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "ref",
+ "sha"
+ ]
+ },
+ "example": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "create-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "ref",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA1 value for this reference.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value for this reference.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"refs/heads/newbranch\"",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"ref\": \"refs/heads/featureA\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"aa218f56b14c9653891f9e74264a383fa43fefbd\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF \\\n -d '{\"sha\":\"sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})\n
"
+ }
+ ],
+ "summary": "Update a reference",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/update-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#update-a-reference"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string",
+ "description": "Required. The SHA1 value to set this reference to
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value to set this reference to",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "force",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "sha"
+ ]
+ },
+ "example": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "update-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The SHA1 value to set this reference to
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA1 value to set this reference to",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "force",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"ref\": \"refs/heads/featureA\",\n \"node_id\": \"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"aa218f56b14c9653891f9e74264a383fa43fefbd\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "ref+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/refs/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/git/refs/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Delete a reference",
+ "description": "",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/delete-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#delete-a-reference"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "refs"
+ },
+ "slug": "delete-a-reference",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "refs",
+ "subcategoryLabel": "Refs",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/tags",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/tags', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag',\n message: 'message',\n object: 'object',\n type: 'type'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/tags', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag',\n message: 'message',\n object: 'object',\n type: 'type'\n})\n
"
+ }
+ ],
+ "summary": "Create a tag object",
+ "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-tag-object"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag": {
+ "type": "string",
+ "description": "Required. The tag's name. This is typically a version (e.g., \"v0.0.1\").
",
+ "name": "tag",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").",
+ "childParamsGroups": []
+ },
+ "message": {
+ "type": "string",
+ "description": "Required. The tag message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag message.",
+ "childParamsGroups": []
+ },
+ "object": {
+ "type": "string",
+ "description": "Required. The SHA of the git object this is tagging.
",
+ "name": "object",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the git object this is tagging.",
+ "childParamsGroups": []
+ },
+ "type": {
+ "type": "string",
+ "description": "Required. The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
",
+ "enum": [
+ "commit",
+ "tree",
+ "blob"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.",
+ "childParamsGroups": []
+ },
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "tagger",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "An object with information about the individual creating the tag.",
+ "childParamsGroups": [
+ {
+ "parentName": "tagger",
+ "parentType": "object",
+ "id": "tagger-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author of the tag
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "tags"
+ },
+ "slug": "create-a-tag-object",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "tags",
+ "subcategoryLabel": "Tags",
+ "notes": [],
+ "descriptionHTML": "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 the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"node_id\": \"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\n \"tag\": \"v0.0.1\",\n \"sha\": \"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"message\": \"initial version\",\n \"tagger\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\",\n \"date\": \"2014-11-07T22:01:45Z\"\n },\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"\n },\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The tag's name. This is typically a version (e.g., \"v0.0.1\").
",
+ "name": "tag",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The tag message.
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The tag message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The SHA of the git object this is tagging.
",
+ "name": "object",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The SHA of the git object this is tagging.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
",
+ "enum": [
+ "commit",
+ "tree",
+ "blob"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.",
+ "childParamsGroups": []
+ },
+ {
+ "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
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ "date": {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ },
+ "name": "tagger",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "An object with information about the individual creating the tag.",
+ "childParamsGroups": [
+ {
+ "parentName": "tagger",
+ "parentType": "object",
+ "id": "tagger-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "The name of the author of the tag
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The email of the author of the tag
",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The email of the author of the tag",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "date",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "tag_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/tags/TAG_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/tags/{tag_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_sha: 'tag_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/tags/{tag_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_sha: 'tag_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a tag",
+ "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#get-a-tag"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "tags"
+ },
+ "slug": "get-a-tag",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "tags",
+ "subcategoryLabel": "Tags",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
\nThese are the possible values for reason in the verification object:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| 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. |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"node_id\": \"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\n \"tag\": \"v0.0.1\",\n \"sha\": \"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\n \"message\": \"initial version\",\n \"tagger\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"octocat@github.com\",\n \"date\": \"2014-11-07T22:01:45Z\"\n },\n \"object\": {\n \"type\": \"commit\",\n \"sha\": \"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"\n },\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/git/trees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees \\\n -d '{\"tree\":[{\"path\":\"path\",\"mode\":\"mode\",\"type\":\"type\",\"sha\":\"sha\",\"content\":\"content\"}]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/git/trees', {\n owner: 'octocat',\n repo: 'hello-world',\n tree: [\n {\n path: 'path',\n mode: 'mode',\n type: 'type',\n sha: 'sha',\n content: 'content'\n }\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/git/trees', {\n owner: 'octocat',\n repo: 'hello-world',\n tree: [\n {\n path: 'path',\n mode: 'mode',\n type: 'type',\n sha: 'sha',\n content: 'content'\n }\n ]\n})\n
"
+ }
+ ],
+ "summary": "Create a tree",
+ "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@2.19/rest/reference/git#update-a-reference).\"",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#create-a-tree"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tree": {
+ "type": "array of objects",
+ "description": "Required. 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.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "type": {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "name": "tree",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.",
+ "childParamsGroups": [
+ {
+ "parentName": "tree",
+ "parentType": "items",
+ "id": "tree-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "The file referenced in the tree.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ {
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "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.
",
+ "name": "base_tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "tree"
+ ]
+ },
+ "example": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "trees"
+ },
+ "slug": "create-a-tree",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "trees",
+ "subcategoryLabel": "Trees",
+ "notes": [],
+ "descriptionHTML": "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.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"tree\": [\n {\n \"path\": \"file.rb\",\n \"mode\": \"100644\",\n \"type\": \"blob\",\n \"size\": 132,\n \"sha\": \"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"\n }\n ],\n \"truncated\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "array of objects",
+ "description": "Required. 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.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "type": {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "name": "tree",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.",
+ "childParamsGroups": [
+ {
+ "parentName": "tree",
+ "parentType": "items",
+ "id": "tree-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "The file referenced in the tree.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file referenced in the tree.",
+ "childParamsGroups": []
+ },
+ {
+ "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"
+ ],
+ "name": "mode",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Either blob, tree, or commit.
",
+ "enum": [
+ "blob",
+ "tree",
+ "commit"
+ ],
+ "name": "type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Either `blob`, `tree`, or `commit`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "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.
\nNote: 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,
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\nNote: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
",
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "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.
",
+ "name": "base_tree",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "tree_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "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.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/git/trees/TREE_SHA
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/git/trees/{tree_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/git/trees/{tree_sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})\n
"
+ }
+ ],
+ "summary": "Get a tree",
+ "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/git#get-a-tree"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "git",
+ "subcategory": "trees"
+ },
+ "slug": "get-a-tree",
+ "category": "git",
+ "categoryLabel": "Git",
+ "subcategory": "trees",
+ "subcategoryLabel": "Trees",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"sha\": \"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\n \"tree\": [\n {\n \"path\": \"file.rb\",\n \"mode\": \"100644\",\n \"type\": \"blob\",\n \"size\": 30,\n \"sha\": \"44b4fc6d56897b048c772eb4087f854f46256132\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"\n },\n {\n \"path\": \"subdir\",\n \"mode\": \"040000\",\n \"type\": \"tree\",\n \"sha\": \"f484d249c660418515fb01c2b9662073663c242e\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"\n },\n {\n \"path\": \"exec_file\",\n \"mode\": \"100755\",\n \"type\": \"blob\",\n \"size\": 75,\n \"sha\": \"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"\n }\n ],\n \"truncated\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response recursively retrieving a tree",
+ "payload": "{\n \"sha\": \"fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\n \"tree\": [\n {\n \"path\": \"subdir/file.txt\",\n \"mode\": \"100644\",\n \"type\": \"blob\",\n \"size\": 132,\n \"sha\": \"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"\n }\n ],\n \"truncated\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository webhooks",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-webhooks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-repository-webhooks"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "list-repository-webhooks",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"token\":\"token\",\"digest\":\"digest\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n token: 'token',\n digest: 'digest'\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n token: 'token',\n digest: 'digest'\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a repository webhook",
+ "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-repository-webhook"
+ },
+ "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.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.",
+ "childParamsGroups": []
+ },
+ "config": {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "token": {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "config"
+ ]
+ },
+ "example": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "create-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Use web to create a webhook. Default: web. This parameter only accepts the value web.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "token": {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"abc\"",
+ "name": "token",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"sha256\"",
+ "name": "digest",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a repository webhook",
+ "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "get-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"address\":\"address\",\"room\":\"room\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n address: 'address',\n room: 'room'\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n address: 'address',\n room: 'room'\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a repository webhook",
+ "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-a-repository-webhook"
+ },
+ "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.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "address": {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "room": {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ "events": {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for. This replaces the entire array of events.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.",
+ "childParamsGroups": []
+ },
+ "add_events": {
+ "type": "array of strings",
+ "description": "Determines a list of events to be added to the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ "remove_events": {
+ "type": "array of strings",
+ "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ "active": {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "update-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "descriptionHTML": "Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"Repository\",\n \"id\": 12345678,\n \"name\": \"web\",\n \"active\": true,\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"config\": {\n \"content_type\": \"json\",\n \"insecure_ssl\": \"0\",\n \"url\": \"https://example.com/webhook\"\n },\n \"updated_at\": \"2019-06-03T00:57:16Z\",\n \"created_at\": \"2019-06-03T00:57:16Z\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\n \"test_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\n \"ping_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\n \"last_response\": {\n \"code\": null,\n \"status\": \"unused\",\n \"message\": null\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. These are defined below.
",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ "address": {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "room": {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "url"
+ ],
+ "name": "config",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-hook-config-params).",
+ "childParamsGroups": [
+ {
+ "parentName": "config",
+ "parentType": "object",
+ "id": "config-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The URL to which the payloads will be delivered.
",
+ "example": "https://example.com/webhook",
+ "format": "uri",
+ "name": "url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The URL to which the payloads will be delivered.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
",
+ "example": "\"json\"",
+ "name": "content_type",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
",
+ "example": "\"********\"",
+ "name": "secret",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#delivery-headers).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.
",
+ "example": "\"0\"",
+ "name": "insecure_ssl",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"bar@example.com\"",
+ "name": "address",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"The Serious Room\"",
+ "name": "room",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines what events the hook is triggered for. This replaces the entire array of events.
",
+ "default": [
+ "push"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "name": "events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines what [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines a list of events to be added to the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "add_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "remove_events",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
",
+ "default": true,
+ "name": "active",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/hooks/{hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository webhook",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "delete-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/pings
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/pings', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/pings', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Ping a repository webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.19/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#ping-a-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "ping-a-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This will trigger a ping event to be sent to the hook.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/hooks/42/tests
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/tests', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/hooks/{hook_id}/tests', {\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Test the push repository webhook",
+ "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/test-push-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#test-the-push-repository-webhook"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "webhooks"
+ },
+ "slug": "test-the-push-repository-webhook",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "webhooks",
+ "subcategoryLabel": "Webhooks",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nNote: Previously /repos/:owner/:repo/hooks/:hook_id/test
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/installation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/installation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/installation', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/installation', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a repository installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-repo-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-a-repository-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-a-repository-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"account\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"html_url\": \"https://github.com/github\",\n \"followers_url\": \"https://api.github.com/users/github/followers\",\n \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"repository_selection\": \"all\",\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"created_at\": \"2018-02-09T20:51:14Z\",\n \"updated_at\": \"2018-02-09T20:51:14Z\",\n \"single_file_name\": \"config.yml\",\n \"app_slug\": \"github-actions\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/invitations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/invitations', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/invitations', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository invitations",
+ "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-repository-invitations"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "list-repository-invitations",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\",\n \"node_id\": \"MDQ6VXNlcjE=\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42 \\\n -d '{\"permissions\":\"permissions\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42,\n permissions: 'permissions'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42,\n permissions: 'permissions'\n})\n
"
+ }
+ ],
+ "summary": "Update a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-a-repository-invitation"
+ },
+ "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"
+ ],
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "update-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "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"
+ ],
+ "name": "permissions",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/invitations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/invitations/{invitation_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-repository-invitation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "delete-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "assignee",
+ "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
"
+ },
+ {
+ "name": "creator",
+ "description": "The user that created the issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "The user that created the issue.
"
+ },
+ {
+ "name": "mentioned",
+ "description": "A user that's mentioned in the issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A user that's mentioned in the issue.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository issues",
+ "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#list-repository-issues"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "list-repository-issues",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Create an issue",
+ "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#create-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ "assignee": {
+ "type": "string or null",
+ "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
",
+ "nullable": true,
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**_",
+ "childParamsGroups": []
+ },
+ "milestone": {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ "labels": {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._",
+ "childParamsGroups": []
+ },
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "example": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "create-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "descriptionHTML": "Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string or null",
+ "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
",
+ "nullable": true,
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.**_",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"closed_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Either asc or desc. Ignored without the sort parameter.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List issue comments for a repository",
+ "description": "By default, Issue Comments are ordered by ascending ID.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-issue-comments-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "list-issue-comments-for-a-repository",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#get-an-issue-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "get-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#update-an-issue-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Me too"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "update-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#delete-an-issue-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "delete-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for an issue comment",
+ "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@2.19/rest/reference/issues#comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#list-reactions-for-an-issue-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-an-issue-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to an issue comment.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for an issue comment",
+ "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@2.19/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#create-reaction-for-an-issue-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the issue comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-an-issue-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the issue comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List issue events for a repository",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-issue-events-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "events"
+ },
+ "slug": "list-issue-events-for-a-repository",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"issue\": {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "event_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/events/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/events/{event_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n event_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/events/{event_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n event_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an issue event",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-event",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#get-an-issue-event"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "events"
+ },
+ "slug": "get-an-issue-event",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"issue\": {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get an issue",
+ "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#get-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "get-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"closed_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Update an issue",
+ "description": "Issue owners and users with push access can edit an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#update-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ "assignee": {
+ "type": "string",
+ "description": "Login for the user that this issue should be assigned to. This field is deprecated.
",
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "State of the issue. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of the issue. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "milestone": {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ "labels": {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "state": "open",
+ "labels": [
+ "bug"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "update-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "descriptionHTML": "Issue owners and users with push access can edit an issue.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the issue.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the issue.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the issue.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Login for the user that this issue should be assigned to. This field is deprecated.
",
+ "name": "assignee",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "State of the issue. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of the issue. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer or null",
+ "description": "The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
",
+ "nullable": true,
+ "name": "milestone",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of undefineds",
+ "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"
+ }
+ }
+ }
+ ]
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"closed_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "301",
+ "httpStatusMessage": "Moved Permanently",
+ "description": "Moved permanently"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Add assignees to an issue",
+ "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#add-assignees-to-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "assignees"
+ },
+ "slug": "add-assignees-to-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "assignees",
+ "subcategoryLabel": "Assignees",
+ "notes": [],
+ "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/assignees \\\n -d '{\"assignees\":[\"assignees\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n assignees: [\n 'assignees'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Remove assignees from an issue",
+ "description": "Removes one or more assignees from an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#remove-assignees-from-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "assignees": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "assignees"
+ },
+ "slug": "remove-assignees-from-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "assignees",
+ "subcategoryLabel": "Assignees",
+ "notes": [],
+ "descriptionHTML": "Removes one or more assignees from an issue.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "assignees",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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._",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"author_association\": \"collaborator\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List issue comments",
+ "description": "Issue Comments are ordered by ascending ID.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-issue-comments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "list-issue-comments",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Issue Comments are ordered by ascending ID.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create an issue comment",
+ "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#create-an-issue-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Me too"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "comments"
+ },
+ "slug": "create-an-issue-comment",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The contents of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDEyOklzc3VlQ29tbWVudDE=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\n \"body\": \"Me too\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List issue events",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-issue-events"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "events"
+ },
+ "slug": "list-issue-events",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List labels for an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-on-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-labels-for-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "list-labels-for-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Add labels to an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#add-labels-to-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "labels"
+ ]
+ },
+ "example": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "add-labels-to-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels \\\n -d '{\"labels\":[\"labels\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n labels: [\n 'labels'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Set labels for an issue",
+ "description": "Removes any previous labels and sets the new labels for an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/set-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#set-labels-for-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "set-labels-for-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "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"
+ },
+ "name": "labels",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Remove all labels from an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-all-labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#remove-all-labels-from-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "remove-all-labels-from-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/labels/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n name: 'name'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Remove a label from an issue",
+ "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/remove-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#remove-a-label-from-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "remove-a-label-from-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock \\\n -d '{\"lock_reason\":\"lock_reason\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n lock_reason: 'lock_reason'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n lock_reason: 'lock_reason'\n})\n
"
+ }
+ ],
+ "summary": "Lock an issue",
+ "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/lock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#lock-an-issue"
+ },
+ "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"
+ ],
+ "name": "lock_reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "lock-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "Users with push access can lock an issue or pull request's conversation.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "bodyParameters": [
+ {
+ "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"
+ ],
+ "name": "lock_reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/lock
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Unlock an issue",
+ "description": "Users with push access can unlock an issue's conversation.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/unlock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#unlock-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": null
+ },
+ "slug": "unlock-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with push access can unlock an issue's conversation.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for an issue",
+ "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@2.19/rest/reference/issues).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#list-reactions-for-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-an-issue",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to an issue.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for an issue",
+ "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@2.19/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#create-reaction-for-an-issue"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the issue.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-an-issue",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to an issue. A response with a Status: 200 OK means that you already added the reaction type to this issue.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the issue.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the issue.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "issue_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/issues/42/timeline
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'mockingbird'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}/timeline', {\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 42,\n mediaType: {\n previews: [\n 'mockingbird'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List timeline events for an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-timeline",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-timeline-events-for-an-issue"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mockingbird",
+ "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```",
+ "html": "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 for full details. To access the API you must provide a custom media type in the Accept header:
\napplication/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).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```",
+ "html": "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.
\nTo receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:
\napplication/vnd.github.starfox-preview+json
"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "timeline"
+ },
+ "slug": "list-timeline-events-for-an-issue",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "timeline",
+ "subcategoryLabel": "Timeline",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDEwOklzc3VlRXZlbnQx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\n \"actor\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"event\": \"closed\",\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"commit_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"created_at\": \"2011-04-14T16:00:49Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List deploy keys",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deploy-keys",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-deploy-keys"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "list-deploy-keys",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})\n
"
+ }
+ ],
+ "summary": "Create a deploy key",
+ "description": "You can create a read-only deploy key.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-deploy-key"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "A name for the key.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A name for the key.",
+ "childParamsGroups": []
+ },
+ "key": {
+ "type": "string",
+ "description": "Required. The contents of the key.
",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the key.",
+ "childParamsGroups": []
+ },
+ "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.
\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\" and \"Permission levels for a user account repository.\"
",
+ "name": "read_only",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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/).\"",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "key"
+ ]
+ },
+ "example": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "create-a-deploy-key",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "descriptionHTML": "You can create a read-only deploy key.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "A name for the key.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A name for the key.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The contents of the key.
",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the key.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
\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\" and \"Permission levels for a user account repository.\"
",
+ "name": "read_only",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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/).\"",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a deploy key",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-deploy-key"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "get-a-deploy-key",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a deploy key",
+ "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-deploy-key",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-deploy-key"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "keys"
+ },
+ "slug": "delete-a-deploy-key",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List labels for a repository",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-labels-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "list-labels-for-a-repository",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Create a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#create-a-label"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. 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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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/).",
+ "childParamsGroups": []
+ },
+ "color": {
+ "type": "string",
+ "description": "The hexadecimal color code for the label, without the leading #.
",
+ "name": "color",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the label.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the label.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "create-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. 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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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/).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The hexadecimal color code for the label, without the leading #.
",
+ "name": "color",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the label.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the label.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Get a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#get-a-label"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "get-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME \\\n -d '{\"new_name\":\"new_name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n new_name: 'new_name'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n new_name: 'new_name'\n})\n
"
+ }
+ ],
+ "summary": "Update a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#update-a-label"
+ },
+ "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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
",
+ "name": "new_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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/).",
+ "childParamsGroups": []
+ },
+ "color": {
+ "type": "string",
+ "description": "The hexadecimal color code for the label, without the leading #.
",
+ "name": "color",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the label.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the label.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "update-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
",
+ "name": "new_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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/).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The hexadecimal color code for the label, without the leading #.
",
+ "name": "color",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the label.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the label.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\n \"name\": \"bug :bug:\",\n \"description\": \"Small bug fix required\",\n \"color\": \"b01f26\",\n \"default\": true\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/labels/{name}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/labels/NAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/labels/{name}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Delete a label",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-label",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#delete-a-label"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "delete-a-label",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/languages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/languages
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/languages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/languages', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository languages",
+ "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-languages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-repository-languages"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-languages",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"C\": 78769,\n \"Python\": 7769\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/license",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/license
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/license', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/license', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the license for a repository",
+ "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/licenses/#get-the-license-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "licenses",
+ "subcategory": null
+ },
+ "slug": "get-the-license-for-a-repository",
+ "category": "licenses",
+ "categoryLabel": "Licenses",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"name\": \"LICENSE\",\n \"path\": \"LICENSE\",\n \"sha\": \"401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"size\": 1077,\n \"url\": \"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\n \"html_url\": \"https://github.com/benbalter/gman/blob/master/LICENSE\",\n \"git_url\": \"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"download_url\": \"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\n \"type\": \"file\",\n \"content\": \"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\n \"encoding\": \"base64\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\n \"git\": \"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"html\": \"https://github.com/benbalter/gman/blob/master/LICENSE\"\n },\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/merges",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/merges', {\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/merges', {\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})\n
"
+ }
+ ],
+ "summary": "Merge a branch",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#merge-a-branch"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "base": {
+ "type": "string",
+ "description": "Required. The name of the base branch that the head will be merged into.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the base branch that the head will be merged into.",
+ "childParamsGroups": []
+ },
+ "head": {
+ "type": "string",
+ "description": "Required. The head to merge. This can be a branch name or a commit SHA1.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.",
+ "childParamsGroups": []
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Commit message to use for the merge commit. If omitted, a default message will be used.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "base",
+ "head"
+ ]
+ },
+ "example": {
+ "base": "master",
+ "head": "cool_feature",
+ "commit_message": "Shipped cool_feature!"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "merging"
+ },
+ "slug": "merge-a-branch",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "merging",
+ "subcategoryLabel": "Merging",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the base branch that the head will be merged into.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the base branch that the head will be merged into.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The head to merge. This can be a branch name or a commit SHA1.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The head to merge. This can be a branch name or a commit SHA1.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Commit message to use for the merge commit. If omitted, a default message will be used.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Commit message to use for the merge commit. If omitted, a default message will be used.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"mona@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ],\n \"stats\": {\n \"additions\": 104,\n \"deletions\": 4,\n \"total\": 108\n },\n \"files\": [\n {\n \"filename\": \"file1.txt\",\n \"additions\": 10,\n \"deletions\": 2,\n \"changes\": 12,\n \"status\": \"modified\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\n \"patch\": \"@@ -29,7 +29,7 @@\\n.....\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Missing base response",
+ "payload": "{\n \"message\": \"Base does not exist\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Missing head response",
+ "payload": "{\n \"message\": \"Head does not exist\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Merge conflict response",
+ "payload": "{\n \"message\": \"Merge Conflict\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/milestones",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "The state of the milestone. Either open, closed, or all.
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Either `due_on` or `completeness`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "due_on",
+ "completeness"
+ ],
+ "default": "due_on"
+ },
+ "descriptionHTML": "What to sort results by. Either due_on or completeness.
"
+ },
+ {
+ "name": "direction",
+ "description": "The direction of the sort. Either `asc` or `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "asc"
+ },
+ "descriptionHTML": "The direction of the sort. Either asc or desc.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List milestones",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-milestones",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-milestones"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "list-milestones",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/milestones",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/milestones', {\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Create a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#create-a-milestone"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ "due_on": {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "example": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "create-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#get-a-milestone"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "get-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Update a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#update-a-milestone"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ "due_on": {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "update-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the milestone.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The state of the milestone. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "default": "open",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the milestone. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A description of the milestone.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A description of the milestone.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
",
+ "name": "due_on",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/milestones/{milestone_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/delete-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#delete-a-milestone"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "milestones"
+ },
+ "slug": "delete-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "milestones",
+ "subcategoryLabel": "Milestones",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "milestone_number parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/milestones/42/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels', {\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List labels for issues in a milestone",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-labels-for-milestone",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/issues#list-labels-for-issues-in-a-milestone"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "issues",
+ "subcategory": "labels"
+ },
+ "slug": "list-labels-for-issues-in-a-milestone",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "subcategory": "labels",
+ "subcategoryLabel": "Labels",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n },\n {\n \"id\": 208045947,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDc=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\n \"name\": \"enhancement\",\n \"description\": \"New feature or request\",\n \"color\": \"a2eeef\",\n \"default\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/notifications",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "all",
+ "description": "If `true`, show notifications marked as read.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ },
+ "descriptionHTML": "If true, show notifications marked as read.
"
+ },
+ {
+ "name": "participating",
+ "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ },
+ "descriptionHTML": "If true, only shows notifications in which the user is directly participating or mentioned.
"
+ },
+ {
+ "name": "since",
+ "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "before",
+ "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository notifications for the authenticated user",
+ "description": "List all notifications for the current user.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-notifications-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repository-notifications-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "list-repository-notifications-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all notifications for the current user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": \"1\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"subject\": {\n \"title\": \"Greetings\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n \"type\": \"Issue\"\n },\n \"reason\": \"subscribed\",\n \"unread\": true,\n \"updated_at\": \"2014-11-07T22:01:45Z\",\n \"last_read_at\": \"2014-11-07T22:01:45Z\",\n \"url\": \"https://api.github.com/notifications/threads/1\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/notifications",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world',\n last_read_at: 'last_read_at'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/notifications', {\n owner: 'octocat',\n repo: 'hello-world',\n last_read_at: 'last_read_at'\n})\n
"
+ }
+ ],
+ "summary": "Mark repository notifications as read",
+ "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](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 Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-repo-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#mark-repository-notifications-as-read"
+ },
+ "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 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "notifications"
+ },
+ "slug": "mark-repository-notifications-as-read",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "notifications",
+ "subcategoryLabel": "Notifications",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "descriptionHTML": "Marks all notifications in a repository as \"read\" removes them from the default view on GitHub Enterprise Server. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server 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 endpoint and pass the query parameter all=false.
",
+ "bodyParameters": [
+ {
+ "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 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
",
+ "name": "last_read_at",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a GitHub Enterprise Server Pages site",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-github-pages-site"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "get-a-github-enterprise-server-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages\",\n \"status\": \"built\",\n \"cname\": \"developer.github.com\",\n \"custom_404\": false,\n \"html_url\": \"https://developer.github.com\",\n \"source\": {\n \"branch\": \"master\",\n \"path\": \"/\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a GitHub Pages site",
+ "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-github-pages-site"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "The source branch and directory used to publish your Pages site.",
+ "properties": {
+ "source": {
+ "type": "object",
+ "description": "Required. The source branch and directory used to publish your Pages site.
",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "branch"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The source branch and directory used to publish your Pages site.",
+ "childParamsGroups": [
+ {
+ "parentName": "source",
+ "parentType": "object",
+ "id": "source-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "source"
+ ]
+ },
+ "example": {
+ "source": {
+ "branch": "master",
+ "path": "/docs"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "switcheroo",
+ "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
+ "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.switcheroo-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "create-a-github-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "descriptionHTML": "Configures a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages\",\n \"status\": \"built\",\n \"cname\": \"developer.github.com\",\n \"custom_404\": false,\n \"html_url\": \"https://developer.github.com\",\n \"source\": {\n \"branch\": \"master\",\n \"path\": \"/\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "object",
+ "description": "Required. The source branch and directory used to publish your Pages site.
",
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "branch"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "object",
+ "rawDescription": "The source branch and directory used to publish your Pages site.",
+ "childParamsGroups": [
+ {
+ "parentName": "source",
+ "parentType": "object",
+ "id": "source-object",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The repository branch used to publish your site's source files. Can be either master or gh-pages.
",
+ "enum": [
+ "master",
+ "gh-pages"
+ ],
+ "name": "branch",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository branch used to publish your site's source files. Can be either `master` or `gh-pages`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When branch is master, you can change path to /docs. When branch is gh-pages, you are unable to specify a path other than /.
",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":\"source\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: 'source'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: 'source'\n})\n
"
+ }
+ ],
+ "summary": "Update information about a GitHub Pages site",
+ "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-information-about-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-information-about-a-github-pages-site"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ }
+ ],
+ "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"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\"`.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "source": "master /docs"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "update-information-about-a-github-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.
",
+ "bodyParameters": [
+ {
+ "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"
+ ]
+ }
+ ],
+ "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"
+ ],
+ "name": "source",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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\"`.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pages",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Delete a GitHub Enterprise Server Pages site",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-github-pages-site"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "switcheroo",
+ "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
+ "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.switcheroo-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "delete-a-github-enterprise-server-pages-site",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List GitHub Enterprise Server Pages builds",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pages-builds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-github-pages-builds"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "list-github-enterprise-server-pages-builds",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\n \"status\": \"built\",\n \"error\": {\n \"message\": null\n },\n \"pusher\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"commit\": \"351391cdcb88ffae71ec3028c91f375a8036a26b\",\n \"duration\": 2104,\n \"created_at\": \"2014-02-10T19:00:49Z\",\n \"updated_at\": \"2014-02-10T19:00:51Z\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pages/builds', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Request a GitHub Enterprise Server Pages build",
+ "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/request-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#request-a-github-pages-build"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "request-a-github-enterprise-server-pages-build",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\n \"status\": \"queued\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds/latest",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/latest
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get latest Pages build",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-latest-pages-build"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "get-latest-pages-build",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\n \"status\": \"built\",\n \"error\": {\n \"message\": null\n },\n \"pusher\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"commit\": \"351391cdcb88ffae71ec3028c91f375a8036a26b\",\n \"duration\": 2104,\n \"created_at\": \"2014-02-10T19:00:49Z\",\n \"updated_at\": \"2014-02-10T19:00:51Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "build_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/builds/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/{build_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n build_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pages/builds/{build_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n build_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get GitHub Enterprise Server Pages build",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-github-pages-build"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "pages"
+ },
+ "slug": "get-github-enterprise-server-pages-build",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "pages",
+ "subcategoryLabel": "Pages",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\n \"status\": \"built\",\n \"error\": {\n \"message\": null\n },\n \"pusher\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"commit\": \"351391cdcb88ffae71ec3028c91f375a8036a26b\",\n \"duration\": 2104,\n \"created_at\": \"2014-02-10T19:00:49Z\",\n \"updated_at\": \"2014-02-10T19:00:51Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List pre-receive hooks for a repository",
+ "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.",
+ "operationId": "enterprise-admin/list-pre-receive-hooks-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "list-pre-receive-hooks-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a pre-receive hook for a repository",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "get-a-pre-receive-hook-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42 \\\n -d '{\"enforcement\":\"enforcement\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n enforcement: 'enforcement',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n enforcement: 'enforcement',\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update pre-receive hook enforcement for a repository",
+ "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`",
+ "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enforcement": {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "enforcement": "enabled"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "update-pre-receive-hook-enforcement-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
",
+ "bodyParameters": [
+ {
+ "description": "The state of enforcement for the hook on this repository.
",
+ "type": "string",
+ "name": "enforcement",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of enforcement for the hook on this repository.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"enabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.eye-scream-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pre-receive-hooks/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 42,\n mediaType: {\n previews: [\n 'eye-scream'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove pre-receive hook enforcement for a repository",
+ "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.",
+ "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```",
+ "html": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.eye-scream-preview
"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ },
+ "slug": "remove-pre-receive-hook-enforcement-for-a-repository",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "repo-pre-receive-hooks",
+ "subcategoryLabel": "Repo pre receive hooks",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes any overridden enforcement on this repository for the specified hook.
\nResponds with effective values inherited from owner and/or global level.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 42,\n \"name\": \"Check Commits\",\n \"enforcement\": \"disabled\",\n \"configuration_url\": \"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List repository projects",
+ "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#list-repository-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "list-repository-projects",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n \"url\": \"https://api.github.com/projects/1002604\",\n \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n \"id\": 1002604,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n \"name\": \"Projects Documentation\",\n \"body\": \"Developer documentation project for the developer site.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/projects \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/projects', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a repository project",
+ "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#create-a-repository-project"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the project.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the project.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "create-a-repository-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the project.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the project.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the project.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the project.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n \"url\": \"https://api.github.com/projects/1002604\",\n \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n \"id\": 1002604,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n \"name\": \"Projects Documentation\",\n \"body\": \"Developer documentation project for the developer site.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "410",
+ "httpStatusMessage": "Gone",
+ "description": "Gone"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Either open, closed, or all to filter by state.
"
+ },
+ {
+ "name": "head",
+ "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
"
+ },
+ {
+ "name": "base",
+ "description": "Filter pulls by base branch name. Example: `gh-pages`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Filter pulls by base branch name. Example: gh-pages.
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "popularity",
+ "long-running"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).
"
+ },
+ {
+ "name": "direction",
+ "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#list-pull-requests"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```",
+ "html": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the blog post preview for more details. To access the new draft parameter during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.shadow-cat-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "pulls"
+ },
+ "slug": "list-pull-requests",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls \\\n -d '{\"head\":\"head\",\"base\":\"base\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world',\n head: 'head',\n base: 'base'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls', {\n owner: 'octocat',\n repo: 'hello-world',\n head: 'head',\n base: 'base'\n})\n
"
+ }
+ ],
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#create-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the new pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the new pull request.",
+ "childParamsGroups": []
+ },
+ "head": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ "base": {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ "maintainer_can_modify": {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "issue": {
+ "type": "integer",
+ "example": "1",
+ "name": "issue",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "head",
+ "base"
+ ]
+ },
+ "example": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```",
+ "html": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the blog post preview for more details. To access the new draft parameter during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.shadow-cat-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "pulls"
+ },
+ "slug": "create-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the new pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the new pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "head",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. 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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "1",
+ "name": "issue",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false,\n \"merged\": false,\n \"mergeable\": true,\n \"rebaseable\": true,\n \"mergeable_state\": \"clean\",\n \"merged_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"comments\": 10,\n \"review_comments\": 0,\n \"maintainer_can_modify\": true,\n \"commits\": 3,\n \"additions\": 100,\n \"deletions\": 3,\n \"changed_files\": 5\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be either asc or desc. Ignored without sort parameter.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List review comments in a repository",
+ "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-review-comments-in-a-repository"
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "list-review-comments-in-a-repository",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "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.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-review-comment-for-a-pull-request"
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "get-a-review-comment-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nProvides details for a review comment.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "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.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#update-a-review-comment-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The text of the reply to the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the reply to the review comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "I like this too!"
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.comfort-fade-preview+json
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "update-a-review-comment-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nEnables you to edit a review comment.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The text of the reply to the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the reply to the review comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a review comment for a pull request",
+ "description": "Deletes a review comment.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/delete-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#delete-a-review-comment-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "delete-a-review-comment-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes a review comment.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a pull request review comment",
+ "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#review-comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#list-reactions-for-a-pull-request-review-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "list-reactions-for-a-pull-request-review-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a pull request review comment.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions', {\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a pull request review comment",
+ "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#create-reaction-for-a-pull-request-review-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the pull request review comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the pull request review comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ },
+ "slug": "create-reaction-for-a-pull-request-review-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the pull request review comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the pull request review comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a pull request",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.19/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#get-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "get-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server 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\".
\nThe value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server 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.
\nThe value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
\n\n- If merged as a merge commit,
merge_commit_sha represents the SHA of the merge commit. \n- If merged via a squash,
merge_commit_sha represents the SHA of the squashed commit on the base branch. \n- If rebased,
merge_commit_sha represents the commit that the base branch was updated to. \n
\nPass the appropriate media type to fetch diff and patch formats.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false,\n \"merged\": false,\n \"mergeable\": true,\n \"rebaseable\": true,\n \"mergeable_state\": \"clean\",\n \"merged_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"comments\": 10,\n \"review_comments\": 0,\n \"maintainer_can_modify\": true,\n \"commits\": 3,\n \"additions\": 100,\n \"deletions\": 3,\n \"changed_files\": 5\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/pulls/{pull_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#update-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the pull request.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "description": "State of this Pull Request. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of this Pull Request. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "maintainer_can_modify": {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```",
+ "html": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the blog post preview for more details. To access the new draft parameter during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.shadow-cat-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```",
+ "html": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in locked events. This feature is currently available for developers to preview. See the blog post for full details. To access this feature, you must provide a custom media type in the Accept header:
\napplication/vnd.github.sailor-v-preview+json
"
+ }
+ ],
+ "category": "pulls"
+ },
+ "slug": "update-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The title of the pull request.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The title of the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The contents of the pull request.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The contents of the pull request.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "State of this Pull Request. Either open or closed.
",
+ "enum": [
+ "open",
+ "closed"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "State of this Pull Request. Either `open` or `closed`.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "base",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Indicates whether maintainers can modify the pull request.
",
+ "name": "maintainer_can_modify",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"forks\": 123,\n \"open_issues\": 123,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"watchers\": 123,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false,\n \"merged\": false,\n \"mergeable\": true,\n \"rebaseable\": true,\n \"mergeable_state\": \"clean\",\n \"merged_by\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"comments\": 10,\n \"review_comments\": 0,\n \"maintainer_can_modify\": true,\n \"commits\": 3,\n \"additions\": 100,\n \"deletions\": 3,\n \"changed_files\": 5\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be either asc or desc. Ignored without sort parameter.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "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.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-review-comments-on-a-pull-request"
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "list-review-comments-on-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Multi-line comments on pull requests are currently in public beta and subject to change.
\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.
\nMulti-line comment summary
\nNote: 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 for full details.
\nUse the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.
\nIf you use the comfort-fade preview header, your response will show:
\n\n- For multi-line comments, values for
start_line, original_start_line, start_side, line, original_line, and side. \n- For single-line comments, values for
line, original_line, and side and a null value for start_line, original_start_line, and start_side. \n
\nIf you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:
\n\n- For multi-line comments, the last line of the comment range for the
position attribute. \n- For single-line comments, the diff-positioned way of referencing comments for the
position attribute. For more information, see position in the input parameters table. \n
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a review comment for a pull request (alternative)",
+ "description": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.19/rest/reference/issues#create-an-issue-comment).\"\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "pulls/create-review-comment-alternative",
+ "tags": [
+ "pulls"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#create-a-review-comment-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The text of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the comment.",
+ "childParamsGroups": []
+ },
+ "in_reply_to": {
+ "type": "integer",
+ "description": "The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.
",
+ "name": "in_reply_to",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The comment ID to reply to. **Note**: This must be the ID of a _top-level comment_, not a reply to that comment. Replies to replies are not supported.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Nice change"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "create-a-review-comment-for-a-pull-request-alternative",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"
\nNote: 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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The text of the comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.
",
+ "name": "in_reply_to",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The comment ID to reply to. **Note**: This must be the ID of a _top-level comment_, not a reply to that comment. Replies to replies are not supported.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "comment_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/comments/42/replies \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n comment_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n comment_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a reply for a review comment",
+ "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-reply-for-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#create-a-reply-for-a-review-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the review comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Great stuff!"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "comments"
+ },
+ "slug": "create-a-reply-for-a-review-comment",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "comments",
+ "subcategoryLabel": "Comments",
+ "notes": [],
+ "descriptionHTML": "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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The text of the review comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/commits
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/commits', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List commits on a pull request",
+ "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commits) endpoint.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#list-commits-on-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "list-commits-on-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"node_id\": \"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"author\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"support@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"committer\": {\n \"name\": \"Monalisa Octocat\",\n \"email\": \"support@github.com\",\n \"date\": \"2011-04-14T16:00:49Z\"\n },\n \"message\": \"Fix all the bugs\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n },\n \"comment_count\": 0,\n \"verification\": {\n \"verified\": false,\n \"reason\": \"unsigned\",\n \"signature\": null,\n \"payload\": null\n }\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n ]\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/files
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/files', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/files', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List pull requests files",
+ "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-files",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#list-pull-requests-files"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "list-pull-requests-files",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"sha\": \"bbcd538c8e72b8c175046e27cc8f907076331401\",\n \"filename\": \"file1.txt\",\n \"status\": \"added\",\n \"additions\": 103,\n \"deletions\": 21,\n \"changes\": 124,\n \"blob_url\": \"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"raw_url\": \"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"patch\": \"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "500",
+ "httpStatusMessage": "Internal Server Error",
+ "description": "Internal error"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Check if a pull request has been merged",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/check-if-merged",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#check-if-a-pull-request-has-been-merged"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "check-if-a-pull-request-has-been-merged",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if pull request has been merged"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if pull request has not been merged"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/merge \\\n -d '{\"commit_title\":\"commit_title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_title: 'commit_title'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_title: 'commit_title'\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#merge-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "commit_title": {
+ "type": "string",
+ "description": "Title for the automatic commit message.
",
+ "name": "commit_title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Title for the automatic commit message.",
+ "childParamsGroups": []
+ },
+ "commit_message": {
+ "type": "string",
+ "description": "Extra detail to append to automatic commit message.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Extra detail to append to automatic commit message.",
+ "childParamsGroups": []
+ },
+ "sha": {
+ "type": "string",
+ "description": "SHA that pull request head must match to allow merge.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "SHA that pull request head must match to allow merge.",
+ "childParamsGroups": []
+ },
+ "merge_method": {
+ "type": "string",
+ "description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge.
",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ],
+ "name": "merge_method",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "merge-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Title for the automatic commit message.
",
+ "name": "commit_title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Title for the automatic commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Extra detail to append to automatic commit message.
",
+ "name": "commit_message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Extra detail to append to automatic commit message.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "SHA that pull request head must match to allow merge.
",
+ "name": "sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "SHA that pull request head must match to allow merge.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge.
",
+ "enum": [
+ "merge",
+ "squash",
+ "rebase"
+ ],
+ "name": "merge_method",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if merge was successful",
+ "payload": "{\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"merged\": true,\n \"message\": \"Pull Request successfully merged\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "405",
+ "httpStatusMessage": "Method Not Allowed",
+ "description": "Response if merge cannot be performed",
+ "payload": "{\n \"message\": \"Pull Request is not mergeable\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Response if sha was provided and pull request head did not match",
+ "payload": "{\n \"message\": \"Head branch was modified. Review and try the merge again.\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List requested reviewers for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-requested-reviewers-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "review-requests"
+ },
+ "slug": "list-requested-reviewers-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "review-requests",
+ "subcategoryLabel": "Review requests",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"users\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})\n
"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/request-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#request-reviewers-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reviewers": {
+ "type": "array of strings",
+ "description": "An array of user logins that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be requested.",
+ "childParamsGroups": []
+ },
+ "team_reviewers": {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be requested.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "review-requests"
+ },
+ "slug": "request-reviewers-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "review-requests",
+ "subcategoryLabel": "Review requests",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "An array of user logins that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be requested.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be requested.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be requested.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"id\": 1,\n \"node_id\": \"MDExOlB1bGxSZXF1ZXN0MQ==\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\",\n \"issue_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\n \"review_comments_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\n \"review_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"number\": 1347,\n \"state\": \"open\",\n \"locked\": true,\n \"title\": \"Amazing new feature\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Please pull these awesome changes in!\",\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"active_lock_reason\": \"too heated\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:01:12Z\",\n \"closed_at\": \"2011-01-26T19:01:12Z\",\n \"merged_at\": \"2011-01-26T19:01:12Z\",\n \"merge_commit_sha\": \"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n }\n ],\n \"requested_reviewers\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n {\n \"login\": \"hubot\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/hubot\",\n \"html_url\": \"https://github.com/hubot\",\n \"followers_url\": \"https://api.github.com/users/hubot/followers\",\n \"following_url\": \"https://api.github.com/users/hubot/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/hubot/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/hubot/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/hubot/orgs\",\n \"repos_url\": \"https://api.github.com/users/hubot/repos\",\n \"events_url\": \"https://api.github.com/users/hubot/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/hubot/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n {\n \"login\": \"other_user\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/other_user_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/other_user\",\n \"html_url\": \"https://github.com/other_user\",\n \"followers_url\": \"https://api.github.com/users/other_user/followers\",\n \"following_url\": \"https://api.github.com/users/other_user/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/other_user/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/other_user/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/other_user/orgs\",\n \"repos_url\": \"https://api.github.com/users/other_user/repos\",\n \"events_url\": \"https://api.github.com/users/other_user/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/other_user/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"requested_teams\": [\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n }\n ],\n \"head\": {\n \"label\": \"octocat:new-topic\",\n \"ref\": \"new-topic\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n }\n },\n \"base\": {\n \"label\": \"octocat:master\",\n \"ref\": \"master\",\n \"sha\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"repo\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"anonymous_access_enabled\": false\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1347\"\n },\n \"issue\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\"\n },\n \"comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"\n },\n \"review_comments\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"\n },\n \"review_comment\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"\n },\n \"commits\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"\n },\n \"statuses\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"\n }\n },\n \"author_association\": \"OWNER\",\n \"draft\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if user is not a collaborator"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/requested_reviewers \\\n -d '{\"reviewers\":[\"reviewers\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n reviewers: [\n 'reviewers'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Remove requested reviewers from a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/remove-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reviewers": {
+ "type": "array of strings",
+ "description": "An array of user logins that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be removed.",
+ "childParamsGroups": []
+ },
+ "team_reviewers": {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be removed.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "review-requests"
+ },
+ "slug": "remove-requested-reviewers-from-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "review-requests",
+ "subcategoryLabel": "Review requests",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "An array of user logins that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of user `login`s that will be removed.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of strings",
+ "description": "An array of team slugs that will be removed.
",
+ "items": {
+ "type": "string"
+ },
+ "name": "team_reviewers",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "An array of team `slug`s that will be removed.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List reviews for a pull request",
+ "description": "The list of reviews returns in chronological order.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-reviews",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-reviews-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "list-reviews-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The list of reviews returns in chronological order.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"APPROVED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews \\\n -d '{\"commit_id\":\"commit_id\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_id: 'commit_id'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n commit_id: 'commit_id'\n})\n
"
+ }
+ ],
+ "summary": "Create a review for a pull request",
+ "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.19/rest/reference/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://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#create-a-review-for-a-pull-request"
+ },
+ "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.
",
+ "name": "commit_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.",
+ "childParamsGroups": []
+ },
+ "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 when you are ready.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
+ "childParamsGroups": []
+ },
+ "comments": {
+ "type": "array of objects",
+ "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": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ "line": {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "side": {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_side": {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "body"
+ ]
+ },
+ "name": "comments",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.",
+ "childParamsGroups": [
+ {
+ "parentName": "comments",
+ "parentType": "items",
+ "id": "comments-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "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."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "create-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
\nNote: 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. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
\nThe position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"This is close to perfect! Please address the suggested inline change.\",\n \"state\": \"CHANGES_REQUESTED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "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.
",
+ "name": "commit_id",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.",
+ "childParamsGroups": []
+ },
+ {
+ "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 when you are ready.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of objects",
+ "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": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ "line": {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "side": {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_line": {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ "start_side": {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "path",
+ "body"
+ ]
+ },
+ "name": "comments",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.",
+ "childParamsGroups": [
+ {
+ "parentName": "comments",
+ "parentType": "items",
+ "id": "comments-items",
+ "params": [
+ {
+ "type": "string",
+ "description": "Required. The relative path to the file that necessitates a review comment.
",
+ "name": "path",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The relative path to the file that necessitates a review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "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.
",
+ "name": "position",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. Text of the review comment.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text of the review comment.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "28",
+ "name": "line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"RIGHT\"",
+ "name": "side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "example": "26",
+ "name": "start_line",
+ "in": "body",
+ "rawType": "integer",
+ "description": "undefined
",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"LEFT\"",
+ "name": "start_side",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a review for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#get-a-review-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "get-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"APPROVED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update a review for a pull request",
+ "description": "Update the review summary comment with new text.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#update-a-review-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "This is close to perfect! Please address the suggested inline change. And add more about this."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "update-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "Update the review summary comment with new text.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The body text of the pull request review.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"This is close to perfect! Please address the suggested inline change. And add more about this.\",\n \"state\": \"CHANGES_REQUESTED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a pending review for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/delete-pending-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#delete-a-pending-review-for-a-pull-request"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "delete-a-pending-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"This is close to perfect! Please address the suggested inline change.\",\n \"state\": \"CHANGES_REQUESTED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List comments for a pull request review",
+ "description": "List comments for a specific pull request review.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-comments-for-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-comments-for-a-pull-request-review"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "list-comments-for-a-pull-request-review",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List comments for a specific pull request review.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\n \"pull_request_review_id\": 42,\n \"id\": 10,\n \"node_id\": \"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\n \"diff_hunk\": \"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\n \"path\": \"file1.txt\",\n \"position\": 1,\n \"original_position\": 4,\n \"commit_id\": \"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"original_commit_id\": \"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\n \"in_reply_to_id\": 8,\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Great stuff!\",\n \"created_at\": \"2011-04-14T16:00:49Z\",\n \"updated_at\": \"2011-04-14T16:00:49Z\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\n \"author_association\": \"NONE\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"\n },\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1\"\n }\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/dismissals \\\n -d '{\"message\":\"message\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n message: 'message'\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n message: 'message'\n})\n
"
+ }
+ ],
+ "summary": "Dismiss a review for a pull request",
+ "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/dismiss-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#dismiss-a-review-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Required. The message for the pull request review dismissal
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The message for the pull request review dismissal",
+ "childParamsGroups": []
+ },
+ "event": {
+ "type": "string",
+ "example": "\"APPROVE\"",
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "message"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "dismiss-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The message for the pull request review dismissal
",
+ "name": "message",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The message for the pull request review dismissal",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"APPROVE\"",
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"DISMISSED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "review_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/reviews/42/events \\\n -d '{\"event\":\"event\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n event: 'event'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n review_id: 42,\n event: 'event'\n})\n
"
+ }
+ ],
+ "summary": "Submit a review for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/submit-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#submit-a-review-for-a-pull-request"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The body text of the pull request review
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review",
+ "childParamsGroups": []
+ },
+ "event": {
+ "type": "string",
+ "description": "Required. The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "event"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "pulls",
+ "subcategory": "reviews"
+ },
+ "slug": "submit-a-review-for-a-pull-request",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "subcategory": "reviews",
+ "subcategoryLabel": "Reviews",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The body text of the pull request review
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The body text of the pull request review",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ],
+ "name": "event",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 80,\n \"node_id\": \"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Here is the body for the review.\",\n \"state\": \"APPROVED\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\n \"pull_request_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\n \"_links\": {\n \"html\": {\n \"href\": \"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"\n },\n \"pull_request\": {\n \"href\": \"https://api.github.com/repos/octocat/Hello-World/pulls/12\"\n }\n },\n \"submitted_at\": \"2019-11-17T17:43:43Z\",\n \"commit_id\": \"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\n \"author_association\": \"collaborator\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.lydian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pulls/42/update-branch \\\n -d '{\"expected_head_sha\":\"expected_head_sha\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n expected_head_sha: 'expected_head_sha',\n mediaType: {\n previews: [\n 'lydian'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch', {\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 42,\n expected_head_sha: 'expected_head_sha',\n mediaType: {\n previews: [\n 'lydian'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Update a pull request branch",
+ "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/pulls/#update-a-pull-request-branch"
+ },
+ "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\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
",
+ "name": "expected_head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "lydian",
+ "note": "Updating the pull request branch with latest upstream changes is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.lydian-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.lydian-preview+json
"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": null
+ },
+ "slug": "update-a-pull-request-branch",
+ "category": "pulls",
+ "categoryLabel": "Pulls",
+ "notes": [],
+ "descriptionHTML": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
",
+ "bodyParameters": [
+ {
+ "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\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
",
+ "name": "expected_head_sha",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response",
+ "payload": "{\n \"message\": \"Updating pull request branch.\",\n \"url\": \"https://github.com/repos/octocat/Hello-World/pulls/53\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/readme",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/readme
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/readme', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/readme', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a repository README",
+ "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-readme",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "get-a-repository-readme",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"type\": \"file\",\n \"encoding\": \"base64\",\n \"size\": 5362,\n \"name\": \"README.md\",\n \"path\": \"README.md\",\n \"content\": \"encoded content ...\",\n \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/master/README.md\"\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List releases",
+ "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-releases",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-releases"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "list-releases",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/releases",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases \\\n -d '{\"tag_name\":\"tag_name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_name: 'tag_name'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/releases', {\n owner: 'octocat',\n repo: 'hello-world',\n tag_name: 'tag_name'\n})\n
"
+ }
+ ],
+ "summary": "Create a release",
+ "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-release"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "Required. The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "true to create a draft (unpublished) release, false to create a published one.
",
+ "default": false,
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.",
+ "childParamsGroups": []
+ },
+ "prerelease": {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease. false to identify the release as a full release.
",
+ "default": false,
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "create-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to create a draft (unpublished) release, false to create a published one.
",
+ "default": false,
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to create a draft (unpublished) release, `false` to create a published one.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease. false to identify the release as a full release.
",
+ "default": false,
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "asset_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a release asset",
+ "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-release-asset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. 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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Found"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "asset_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42,\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42,\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update a release asset",
+ "description": "Users with push access to the repository can edit a release asset.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-a-release-asset"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The file name of the asset.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file name of the asset.",
+ "childParamsGroups": []
+ },
+ "label": {
+ "type": "string",
+ "description": "An alternate short description of the asset. Used in place of the filename.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An alternate short description of the asset. Used in place of the filename.",
+ "childParamsGroups": []
+ },
+ "state": {
+ "type": "string",
+ "example": "\"uploaded\"",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "update-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "descriptionHTML": "Users with push access to the repository can edit a release asset.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The file name of the asset.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The file name of the asset.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "An alternate short description of the asset. Used in place of the filename.
",
+ "name": "label",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An alternate short description of the asset. Used in place of the filename.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "example": "\"uploaded\"",
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "description": "undefined
",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "asset_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/assets/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a release asset",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-release-asset"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "delete-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/latest",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/latest
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/latest', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the latest release",
+ "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-the-latest-release"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-the-latest-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "tag",
+ "description": "tag+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "tag+ parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/tags/TAG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/tags/{tag}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/tags/{tag}', {\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag'\n})\n
"
+ }
+ ],
+ "summary": "Get a release by tag name",
+ "description": "Get a published release with the specified tag.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-by-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-release-by-tag-name"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-a-release-by-tag-name",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a published release with the specified tag.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a release",
+ "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#hypermedia).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-release"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "get-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42 \\\n -d '{\"tag_name\":\"tag_name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n tag_name: 'tag_name'\n})",
+ "html": "await octokit.request('PATCH /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n tag_name: 'tag_name'\n})\n
"
+ }
+ ],
+ "summary": "Update a release",
+ "description": "Users with push access to the repository can edit a release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#update-a-release"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tag_name": {
+ "type": "string",
+ "description": "The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ "draft": {
+ "type": "boolean",
+ "description": "true makes the release a draft, and false publishes the release.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` makes the release a draft, and `false` publishes the release.",
+ "childParamsGroups": []
+ },
+ "prerelease": {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease, false to identify the release as a full release.
",
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "update-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "descriptionHTML": "Users with push access to the repository can edit a release.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The name of the tag.
",
+ "name": "tag_name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "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": "target_commitish",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`).",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The name of the release.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the release.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Text describing the contents of the tag.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Text describing the contents of the tag.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true makes the release a draft, and false publishes the release.
",
+ "name": "draft",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` makes the release a draft, and `false` publishes the release.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "true to identify the release as a prerelease, false to identify the release as a full release.
",
+ "name": "prerelease",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v1.0.0\",\n \"target_commitish\": \"master\",\n \"name\": \"v1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/releases/{release_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a release",
+ "description": "Users with push access to the repository can delete a release.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-release"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "delete-a-release",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Users with push access to the repository can delete a release.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List release assets",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-release-assets",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-release-assets"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "list-release-assets",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "release_id parameter
"
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "label",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/releases/42/assets
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/releases/{release_id}/assets', {\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Upload a release asset",
+ "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server 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://docs.github.com/enterprise-server@2.19/rest/reference/repos#upload-a-release-asset"
+ },
+ "servers": [
+ {
+ "url": "{origin}",
+ "variables": {
+ "origin": {
+ "default": "https://uploads.github.com",
+ "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint"
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "string",
+ "description": "The raw file data"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "releases"
+ },
+ "slug": "upload-a-release-asset",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "releases",
+ "subcategoryLabel": "Releases",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint makes use of a Hypermedia relation 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 to upload a release asset.
\nYou need to use an HTTP client which supports SNI to make calls to this endpoint.
\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. For example:
\napplication/zip
\nGitHub Enterprise Server 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.
\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.
\nNotes:
\n\n- GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List assets for a release\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Server Support.
\n- If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
\n
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response for successful upload",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stargazers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stargazers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stargazers', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stargazers', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List stargazers",
+ "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-stargazers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-stargazers"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "list-stargazers",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/code_frequency",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/code_frequency
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/code_frequency', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/code_frequency', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the weekly commit activity",
+ "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-code-frequency-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-the-weekly-commit-activity"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-weekly-commit-activity",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n [\n 1302998400,\n 1124,\n -435\n ]\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/commit_activity",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/commit_activity
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/commit_activity', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/commit_activity', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the last year of commit activity",
+ "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-activity-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-the-last-year-of-commit-activity"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-last-year-of-commit-activity",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"days\": [\n 0,\n 3,\n 26,\n 20,\n 39,\n 1,\n 0\n ],\n \"total\": 89,\n \"week\": 1336280400\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/contributors",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/contributors
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/contributors', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get all contributor commit activity",
+ "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-contributors-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-all-contributor-commit-activity"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-all-contributor-commit-activity",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
\n\nw - Start of the week, given as a Unix timestamp.a - Number of additionsd - Number of deletionsc - Number of commits
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"total\": 135,\n \"weeks\": [\n {\n \"w\": \"1367712000\",\n \"a\": 6898,\n \"d\": 77,\n \"c\": 10\n }\n ]\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/participation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/participation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/participation', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/participation', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the weekly commit count",
+ "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-participation-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-the-weekly-commit-count"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-weekly-commit-count",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThe array order is oldest week (index 0) to most recent week.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"all\": [\n 11,\n 21,\n 15,\n 2,\n 8,\n 1,\n 8,\n 23,\n 17,\n 21,\n 11,\n 10,\n 33,\n 91,\n 38,\n 34,\n 22,\n 23,\n 32,\n 3,\n 43,\n 87,\n 71,\n 18,\n 13,\n 5,\n 13,\n 16,\n 66,\n 27,\n 12,\n 45,\n 110,\n 117,\n 13,\n 8,\n 18,\n 9,\n 19,\n 26,\n 39,\n 12,\n 20,\n 31,\n 46,\n 91,\n 45,\n 10,\n 24,\n 9,\n 29,\n 7\n ],\n \"owner\": [\n 3,\n 2,\n 3,\n 0,\n 2,\n 0,\n 5,\n 14,\n 7,\n 9,\n 1,\n 5,\n 0,\n 48,\n 19,\n 2,\n 0,\n 1,\n 10,\n 2,\n 23,\n 40,\n 35,\n 8,\n 8,\n 2,\n 10,\n 6,\n 30,\n 0,\n 2,\n 9,\n 53,\n 104,\n 3,\n 3,\n 10,\n 4,\n 7,\n 11,\n 21,\n 4,\n 4,\n 22,\n 26,\n 63,\n 11,\n 2,\n 14,\n 1,\n 10,\n 3\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/stats/punch_card",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/stats/punch_card
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/stats/punch_card', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/stats/punch_card', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get the hourly commit count for each day",
+ "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-punch-card-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-the-hourly-commit-count-for-each-day"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statistics"
+ },
+ "slug": "get-the-hourly-commit-count-for-each-day",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statistics",
+ "subcategoryLabel": "Statistics",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Each array contains the day number, hour number, and number of commits:
\n\n0-6: Sunday - Saturday0-23: Hour of day- Number of commits
\n
\nFor example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n [\n 0,\n 0,\n 5\n ],\n [\n 0,\n 1,\n 43\n ],\n [\n 0,\n 2,\n 21\n ]\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/statuses/SHA \\\n -d '{\"state\":\"state\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/statuses/{sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n sha: 'sha',\n state: 'state'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/statuses/{sha}', {\n owner: 'octocat',\n repo: 'hello-world',\n sha: 'sha',\n state: 'state'\n})\n
"
+ }
+ ],
+ "summary": "Create a commit status",
+ "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#create-a-commit-status"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "Required. The state of the status. Can be one of error, failure, pending, or success.
",
+ "enum": [
+ "error",
+ "failure",
+ "pending",
+ "success"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.",
+ "childParamsGroups": []
+ },
+ "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:
\nhttp://ci.example.com/user/repo/build/sha
",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the status.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status.",
+ "childParamsGroups": []
+ },
+ "context": {
+ "type": "string",
+ "description": "A string label to differentiate this status from the status of other systems.
",
+ "default": "default",
+ "name": "context",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A string label to differentiate this status from the status of other systems.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "statuses"
+ },
+ "slug": "create-a-commit-status",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "statuses",
+ "subcategoryLabel": "Statuses",
+ "notes": [],
+ "descriptionHTML": "Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The state of the status. Can be one of error, failure, pending, or success.
",
+ "enum": [
+ "error",
+ "failure",
+ "pending",
+ "success"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.",
+ "childParamsGroups": []
+ },
+ {
+ "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:
\nhttp://ci.example.com/user/repo/build/sha
",
+ "name": "target_url",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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`",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the status.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the status.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A string label to differentiate this status from the status of other systems.
",
+ "default": "default",
+ "name": "context",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A string label to differentiate this status from the status of other systems.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"id\": 1,\n \"node_id\": \"MDY6U3RhdHVzMQ==\",\n \"state\": \"success\",\n \"description\": \"Build has completed successfully\",\n \"target_url\": \"https://ci.example.com/1000/output\",\n \"context\": \"continuous-integration/jenkins\",\n \"created_at\": \"2012-07-20T01:19:13Z\",\n \"updated_at\": \"2012-07-20T01:19:13Z\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/subscribers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscribers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/subscribers', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/subscribers', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List watchers",
+ "description": "Lists the people watching the specified repository.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-watchers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-watchers"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "list-watchers",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people watching the specified repository.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Get a repository subscription",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#get-a-repository-subscription"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "get-a-repository-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if you subscribe to the repository",
+ "payload": "{\n \"subscribed\": true,\n \"ignored\": false,\n \"reason\": null,\n \"created_at\": \"2012-10-06T21:34:12Z\",\n \"url\": \"https://api.github.com/repos/octocat/example/subscription\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if you don t subscribe to the repository"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription \\\n -d '{\"subscribed\":true}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world',\n subscribed: true\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world',\n subscribed: true\n})\n
"
+ }
+ ],
+ "summary": "Set a repository subscription",
+ "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#delete-a-repository-subscription) completely.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#set-a-repository-subscription"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "subscribed": {
+ "type": "boolean",
+ "description": "Determines if notifications should be received from this repository.
",
+ "name": "subscribed",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications should be received from this repository.",
+ "childParamsGroups": []
+ },
+ "ignored": {
+ "type": "boolean",
+ "description": "Determines if all notifications should be blocked from this repository.
",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if all notifications should be blocked from this repository.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "set-a-repository-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "descriptionHTML": "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 completely.
",
+ "bodyParameters": [
+ {
+ "type": "boolean",
+ "description": "Determines if notifications should be received from this repository.
",
+ "name": "subscribed",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if notifications should be received from this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Determines if all notifications should be blocked from this repository.
",
+ "name": "ignored",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Determines if all notifications should be blocked from this repository.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"subscribed\": true,\n \"ignored\": false,\n \"reason\": null,\n \"created_at\": \"2012-10-06T21:34:12Z\",\n \"url\": \"https://api.github.com/repos/octocat/example/subscription\",\n \"repository_url\": \"https://api.github.com/repos/octocat/example\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/subscription",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/subscription
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/subscription', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Delete a repository subscription",
+ "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@2.19/rest/reference/activity#set-a-repository-subscription).",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#delete-a-repository-subscription"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "delete-a-repository-subscription",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/tags",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tags
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/tags', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/tags', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository tags",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-tags",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-repository-tags"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-tags",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"name\": \"v0.1\",\n \"commit\": {\n \"sha\": \"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"\n },\n \"zipball_url\": \"https://github.com/octocat/Hello-World/zipball/v0.1\",\n \"tarball_url\": \"https://github.com/octocat/Hello-World/tarball/v0.1\",\n \"node_id\": \"MDQ6VXNlcjE=\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/tarball/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/tarball/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/tarball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/tarball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Download a repository archive (tar)",
+ "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#download-a-repository-archive"
+ },
+ "operationId": "repos/download-tarball-archive",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "download-a-repository-archive-tar",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/teams', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/teams', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "List repository teams",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-teams",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-repository-teams"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repository-teams",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/topics",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#get-all-repository-topics"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "get-all-repository-topics",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"names\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/topics",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/topics \\\n -d '{\"names\":[\"names\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ],\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/topics', {\n owner: 'octocat',\n repo: 'hello-world',\n names: [\n 'names'\n ],\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Replace all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/replace-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#replace-all-repository-topics"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "names"
+ ]
+ },
+ "example": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "replace-all-repository-topics",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "array of strings",
+ "description": "Required. 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"
+ },
+ "name": "names",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"names\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/transfer",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/transfer \\\n -d '{\"new_owner\":\"new_owner\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/transfer', {\n owner: 'octocat',\n repo: 'hello-world',\n new_owner: 'new_owner'\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/transfer', {\n owner: 'octocat',\n repo: 'hello-world',\n new_owner: 'new_owner'\n})\n
"
+ }
+ ],
+ "summary": "Transfer a repository",
+ "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/transfer",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#transfer-a-repository"
+ },
+ "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.
",
+ "name": "new_owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required:** The username or organization name the repository will be transferred to.",
+ "childParamsGroups": []
+ },
+ "team_ids": {
+ "type": "array of integers",
+ "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
",
+ "items": {
+ "type": "integer"
+ },
+ "name": "team_ids",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "transfer-a-repository",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required: The username or organization name the repository will be transferred to.
",
+ "name": "new_owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**Required:** The username or organization name the repository will be transferred to.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "array of integers",
+ "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
",
+ "items": {
+ "type": "integer"
+ },
+ "name": "team_ids",
+ "in": "body",
+ "rawType": "array",
+ "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Enable vulnerability alerts",
+ "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/enable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#enable-vulnerability-alerts"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "dorian",
+ "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.dorian-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "enable-vulnerability-alerts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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\".
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Disable vulnerability alerts",
+ "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#disable-vulnerability-alerts"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "dorian",
+ "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.dorian-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "disable-vulnerability-alerts",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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\".
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/zipball/{ref}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "ref",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/zipball/REF
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repos/{owner}/{repo}/zipball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})",
+ "html": "await octokit.request('GET /repos/{owner}/{repo}/zipball/{ref}', {\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})\n
"
+ }
+ ],
+ "summary": "Download a repository archive (zip)",
+ "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#download-a-repository-archive"
+ },
+ "operationId": "repos/download-zipball-archive",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "contents"
+ },
+ "slug": "download-a-repository-archive-zip",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "contents",
+ "subcategoryLabel": "Contents",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "302",
+ "httpStatusMessage": "Found",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
"
+ },
+ {
+ "verb": "post",
+ "requestPath": "/repos/{template_owner}/{template_repo}/generate",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "template_owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "template_repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.baptiste-preview+json\" \\\n https://api.github.com/repos/TEMPLATE_OWNER/TEMPLATE_REPO/generate \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{template_owner}/{template_repo}/generate', {\n template_owner: 'template_owner',\n template_repo: 'template_repo',\n name: 'name',\n mediaType: {\n previews: [\n 'baptiste'\n ]\n }\n})",
+ "html": "await octokit.request('POST /repos/{template_owner}/{template_repo}/generate', {\n template_owner: 'template_owner',\n template_repo: 'template_repo',\n name: 'name',\n mediaType: {\n previews: [\n 'baptiste'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a repository using a template",
+ "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-using-template",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#create-a-repository-using-a-template"
+ },
+ "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": "owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the new repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the new repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the new repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the new repository.",
+ "childParamsGroups": []
+ },
+ "include_all_branches": {
+ "type": "boolean",
+ "description": "Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.
",
+ "default": false,
+ "name": "include_all_branches",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either true to create a new private repository or false to create a new public one.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "baptiste",
+ "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "create-a-repository-using-a-template",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "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 endpoint and check that the is_template key is true.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repository
",
+ "bodyParameters": [
+ {
+ "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": "owner",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The name of the new repository.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the new repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "A short description of the new repository.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the new repository.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.
",
+ "default": false,
+ "name": "include_all_branches",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "boolean",
+ "description": "Either true to create a new private repository or false to create a new public one.
",
+ "default": false,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Either `true` to create a new private repository or `false` to create a new public one.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"forks\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"open_issues\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://github.com/licenses/mit\"\n },\n \"anonymous_access_enabled\": false,\n \"template_repository\": {\n \"anonymous_access_enabled\": false\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "since",
+ "description": "A repository ID. Only return repositories with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "A repository ID. Only return repositories with an ID greater than this ID.
"
+ },
+ {
+ "name": "visibility",
+ "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "public",
+ "example": "all",
+ "enum": [
+ "all",
+ "public"
+ ]
+ },
+ "descriptionHTML": "Specifies the types of repositories to return. Can be one of all or public. Default: public.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /repositories')",
+ "html": "await octokit.request('GET /repositories')\n
"
+ }
+ ],
+ "summary": "List public repositories",
+ "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-public-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-public-repositories",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/code",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching code\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@2.19/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "indexed"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/code
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/code', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/code', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search code",
+ "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-code"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-code",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
\nq=addClass+in:file+language:js+repo:jquery/jquery
\nThis query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:
\n\n- Only the default branch is considered. In most cases, this will be the
master branch. \n- Only files smaller than 384 KB are searchable.
\n- You must always include at least one search term when searching source code. For example, searching for
language:go is not valid, while amazing language:go is. \n
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 7,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"name\": \"classes.js\",\n \"path\": \"src/attributes/classes.js\",\n \"sha\": \"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\n \"url\": \"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\n \"git_url\": \"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\n \"html_url\": \"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\n \"repository\": {\n \"id\": 167174,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\n \"name\": \"jquery\",\n \"full_name\": \"jquery/jquery\",\n \"owner\": {\n \"login\": \"jquery\",\n \"id\": 70142,\n \"node_id\": \"MDQ6VXNlcjcwMTQy\",\n \"avatar_url\": \"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/jquery\",\n \"html_url\": \"https://github.com/jquery\",\n \"followers_url\": \"https://api.github.com/users/jquery/followers\",\n \"following_url\": \"https://api.github.com/users/jquery/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/jquery/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/jquery/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/jquery/orgs\",\n \"repos_url\": \"https://api.github.com/users/jquery/repos\",\n \"events_url\": \"https://api.github.com/users/jquery/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/jquery/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/jquery/jquery\",\n \"description\": \"jQuery JavaScript Library\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/jquery/jquery\",\n \"forks_url\": \"https://api.github.com/repos/jquery/jquery/forks\",\n \"keys_url\": \"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\n \"collaborators_url\": \"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\n \"teams_url\": \"https://api.github.com/repos/jquery/jquery/teams\",\n \"hooks_url\": \"https://api.github.com/repos/jquery/jquery/hooks\",\n \"issue_events_url\": \"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\n \"events_url\": \"https://api.github.com/repos/jquery/jquery/events\",\n \"assignees_url\": \"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\n \"branches_url\": \"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\n \"tags_url\": \"https://api.github.com/repos/jquery/jquery/tags\",\n \"blobs_url\": \"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\n \"trees_url\": \"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\n \"statuses_url\": \"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\n \"languages_url\": \"https://api.github.com/repos/jquery/jquery/languages\",\n \"stargazers_url\": \"https://api.github.com/repos/jquery/jquery/stargazers\",\n \"contributors_url\": \"https://api.github.com/repos/jquery/jquery/contributors\",\n \"subscribers_url\": \"https://api.github.com/repos/jquery/jquery/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/jquery/jquery/subscription\",\n \"commits_url\": \"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\n \"git_commits_url\": \"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\n \"comments_url\": \"https://api.github.com/repos/jquery/jquery/comments{/number}\",\n \"issue_comment_url\": \"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\n \"contents_url\": \"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\n \"compare_url\": \"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\n \"merges_url\": \"https://api.github.com/repos/jquery/jquery/merges\",\n \"archive_url\": \"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\n \"downloads_url\": \"https://api.github.com/repos/jquery/jquery/downloads\",\n \"issues_url\": \"https://api.github.com/repos/jquery/jquery/issues{/number}\",\n \"pulls_url\": \"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\n \"milestones_url\": \"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\n \"labels_url\": \"https://api.github.com/repos/jquery/jquery/labels{/name}\",\n \"deployments_url\": \"http://api.github.com/repos/octocat/Hello-World/deployments\",\n \"releases_url\": \"http://api.github.com/repos/octocat/Hello-World/releases{/id}\"\n },\n \"score\": 1\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/commits",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching commits\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@2.19/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "author-date",
+ "committer-date"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query by author-date or committer-date. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.cloak-preview+json\" \\\n https://api.github.com/search/commits
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/commits', {\n q: 'q',\n mediaType: {\n previews: [\n 'cloak'\n ]\n }\n})",
+ "html": "await octokit.request('GET /search/commits', {\n q: 'q',\n mediaType: {\n previews: [\n 'cloak'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Search commits",
+ "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-commits"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "cloak",
+ "note": "The Commit Search API is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2017-01-05-commit-search-api/) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.cloak-preview
"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-commits",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
\nWhen searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
\nFor example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"sha\": \"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"html_url\": \"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\n \"commit\": {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\n \"author\": {\n \"date\": \"2014-02-04T14:38:36-08:00\",\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"date\": \"2014-02-12T15:18:55-08:00\",\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"message\": \"Create styles.css and updated README\",\n \"tree\": {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\n \"sha\": \"a639e96f9038797fba6e0469f94a4b0cc459fa68\"\n },\n \"comment_count\": 8\n },\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 583231,\n \"node_id\": \"MDQ6VXNlcjU4MzIzMQ==\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/583231?v=3\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"committer\": {},\n \"parents\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\n \"html_url\": \"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\n \"sha\": \"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"\n }\n ],\n \"repository\": {\n \"id\": 1300192,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\n \"name\": \"Spoon-Knife\",\n \"full_name\": \"octocat/Spoon-Knife\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 583231,\n \"node_id\": \"MDQ6VXNlcjU4MzIzMQ==\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/583231?v=3\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Spoon-Knife\",\n \"description\": \"This repo is for demonstration purposes only.\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Spoon-Knife\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\n \"events_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/events\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"\n },\n \"score\": 1,\n \"node_id\": \"MDQ6VXNlcjU4MzIzMQ==\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/issues",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching issues and pull requests\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@2.19/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "comments",
+ "reactions",
+ "reactions-+1",
+ "reactions--1",
+ "reactions-smile",
+ "reactions-thinking_face",
+ "reactions-heart",
+ "reactions-tada",
+ "interactions",
+ "created",
+ "updated"
+ ]
+ },
+ "descriptionHTML": "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
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/issues', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/issues', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search issues and pull requests",
+ "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/issues-and-pull-requests",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-issues-and-pull-requests"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-issues-and-pull-requests",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
\nThis query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
\nNote: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 280,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\n \"repository_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\n \"labels_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\n \"events_url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\n \"html_url\": \"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\n \"id\": 35802,\n \"node_id\": \"MDU6SXNzdWUzNTgwMg==\",\n \"number\": 132,\n \"title\": \"Line Number Indexes Beyond 20 Not Displayed\",\n \"user\": {\n \"login\": \"Nick3C\",\n \"id\": 90254,\n \"node_id\": \"MDQ6VXNlcjkwMjU0\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/Nick3C\",\n \"html_url\": \"https://github.com/Nick3C\",\n \"followers_url\": \"https://api.github.com/users/Nick3C/followers\",\n \"following_url\": \"https://api.github.com/users/Nick3C/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/Nick3C/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/Nick3C/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/Nick3C/orgs\",\n \"repos_url\": \"https://api.github.com/users/Nick3C/repos\",\n \"events_url\": \"https://api.github.com/users/Nick3C/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/Nick3C/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"labels\": [\n {\n \"id\": 4,\n \"node_id\": \"MDU6TGFiZWw0\",\n \"url\": \"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\n \"name\": \"bug\",\n \"color\": \"ff0000\"\n }\n ],\n \"state\": \"open\",\n \"assignee\": null,\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"comments\": 15,\n \"created_at\": \"2009-07-12T20:10:41Z\",\n \"updated_at\": \"2009-07-19T09:23:43Z\",\n \"closed_at\": null,\n \"pull_request\": {\n \"url\": \"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"\n },\n \"body\": \"...\",\n \"score\": 1,\n \"locked\": true,\n \"author_association\": \"collaborator\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/labels",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "repository_id",
+ "description": "The id of the repository.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "The id of the repository.
"
+ },
+ {
+ "name": "q",
+ "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.19/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query by when the label was created or updated. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "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.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/labels
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/labels', {\n repository_id: 42,\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/labels', {\n repository_id: 42,\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search labels",
+ "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-labels"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-labels",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
\nq=bug+defect+enhancement&repository_id=64778136
\nThe labels that best match the query appear first in the search results.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 2,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"id\": 418327088,\n \"node_id\": \"MDU6TGFiZWw0MTgzMjcwODg=\",\n \"url\": \"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\n \"name\": \"enhancement\",\n \"color\": \"84b6eb\",\n \"default\": true,\n \"description\": \"New feature or request.\",\n \"score\": 1\n },\n {\n \"id\": 418327086,\n \"node_id\": \"MDU6TGFiZWw0MTgzMjcwODY=\",\n \"url\": \"https://api.github.com/repos/octocat/linguist/labels/bug\",\n \"name\": \"bug\",\n \"color\": \"ee0701\",\n \"default\": true,\n \"description\": \"Something isn't working.\",\n \"score\": 1\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching for repositories\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.19/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "stars",
+ "forks",
+ "help-wanted-issues",
+ "updated"
+ ]
+ },
+ "descriptionHTML": "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
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/repositories', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/repositories', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search repositories",
+ "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-repositories",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
\nThis query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
\nWhen you include the mercy preview header, you can also search for multiple topics by adding more topic: instances. For example, your query might look like this:
\nq=topic:ruby+topic:rails
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 40,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"id\": 3081286,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\n \"name\": \"Tetris\",\n \"full_name\": \"dtrupenn/Tetris\",\n \"owner\": {\n \"login\": \"dtrupenn\",\n \"id\": 872147,\n \"node_id\": \"MDQ6VXNlcjg3MjE0Nw==\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/dtrupenn\",\n \"received_events_url\": \"https://api.github.com/users/dtrupenn/received_events\",\n \"type\": \"User\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"site_admin\": true\n },\n \"private\": false,\n \"html_url\": \"https://github.com/dtrupenn/Tetris\",\n \"description\": \"A C implementation of Tetris using Pennsim through LC4\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/dtrupenn/Tetris\",\n \"created_at\": \"2012-01-01T00:31:50Z\",\n \"updated_at\": \"2013-01-05T17:58:47Z\",\n \"pushed_at\": \"2012-01-01T00:37:02Z\",\n \"homepage\": \"https://github.com\",\n \"size\": 524,\n \"stargazers_count\": 1,\n \"watchers_count\": 1,\n \"language\": \"Assembly\",\n \"forks_count\": 0,\n \"open_issues_count\": 0,\n \"master_branch\": \"master\",\n \"default_branch\": \"master\",\n \"score\": 1,\n \"archive_url\": \"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\n \"events_url\": \"https://api.github.com/repos/dtrupenn/Tetris/events\",\n \"forks_url\": \"https://api.github.com/repos/dtrupenn/Tetris/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\n \"git_url\": \"git:github.com/dtrupenn/Tetris.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/dtrupenn/Tetris/languages\",\n \"merges_url\": \"https://api.github.com/repos/dtrupenn/Tetris/merges\",\n \"milestones_url\": \"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\n \"ssh_url\": \"git@github.com:dtrupenn/Tetris.git\",\n \"stargazers_url\": \"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\n \"tags_url\": \"https://api.github.com/repos/dtrupenn/Tetris/tags\",\n \"teams_url\": \"https://api.github.com/repos/dtrupenn/Tetris/teams\",\n \"trees_url\": \"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/dtrupenn/Tetris.git\",\n \"mirror_url\": \"git:git.example.com/dtrupenn/Tetris\",\n \"hooks_url\": \"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\n \"svn_url\": \"https://svn.github.com/dtrupenn/Tetris\",\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1,\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_pages\": true,\n \"has_wiki\": true,\n \"has_downloads\": true,\n \"archived\": true,\n \"disabled\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n }\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/topics",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.mercy-preview+json\" \\\n https://api.github.com/search/topics
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/topics', {\n q: 'q',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})",
+ "html": "await octokit.request('GET /search/topics', {\n q: 'q',\n mediaType: {\n previews: [\n 'mercy'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Search topics",
+ "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-topics"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-topics",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
\nThis query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 6,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"name\": \"ruby\",\n \"display_name\": \"Ruby\",\n \"short_description\": \"Ruby is a scripting language designed for simplified object-oriented programming.\",\n \"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.\",\n \"created_by\": \"Yukihiro Matsumoto\",\n \"released\": \"December 21, 1995\",\n \"created_at\": \"2016-11-28T22:03:59Z\",\n \"updated_at\": \"2017-10-30T18:16:32Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"rails\",\n \"display_name\": \"Rails\",\n \"short_description\": \"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\n \"description\": \"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\n \"created_by\": \"David Heinemeier Hansson\",\n \"released\": \"December 13 2005\",\n \"created_at\": \"2016-12-09T17:03:50Z\",\n \"updated_at\": \"2017-10-30T16:20:19Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"python\",\n \"display_name\": \"Python\",\n \"short_description\": \"Python is a dynamically typed programming language.\",\n \"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.\",\n \"created_by\": \"Guido van Rossum\",\n \"released\": \"February 20, 1991\",\n \"created_at\": \"2016-12-07T00:07:02Z\",\n \"updated_at\": \"2017-10-27T22:45:43Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"jekyll\",\n \"display_name\": \"Jekyll\",\n \"short_description\": \"Jekyll is a simple, blog-aware static site generator.\",\n \"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.\",\n \"created_by\": \"Tom Preston-Werner\",\n \"released\": \"2008\",\n \"created_at\": \"2016-12-16T21:53:08Z\",\n \"updated_at\": \"2017-10-27T19:00:24Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"sass\",\n \"display_name\": \"Sass\",\n \"short_description\": \"Sass is a stable extension to classic CSS.\",\n \"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.\",\n \"created_by\": \"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\n \"released\": \"November 28, 2006\",\n \"created_at\": \"2016-12-16T21:53:45Z\",\n \"updated_at\": \"2018-01-16T16:30:40Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n },\n {\n \"name\": \"homebrew\",\n \"display_name\": \"Homebrew\",\n \"short_description\": \"Homebrew is a package manager for macOS.\",\n \"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.\",\n \"created_by\": \"Max Howell\",\n \"released\": \"2009\",\n \"created_at\": \"2016-12-17T20:30:44Z\",\n \"updated_at\": \"2018-02-06T16:14:56Z\",\n \"featured\": true,\n \"curated\": true,\n \"score\": 1\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/search/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.19/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "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. See \"Searching users\" for a detailed list of qualifiers.
"
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@2.19/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "followers",
+ "repositories",
+ "joined"
+ ]
+ },
+ "descriptionHTML": "Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/search/users
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /search/users', {\n q: 'q'\n})",
+ "html": "await octokit.request('GET /search/users', {\n q: 'q'\n})\n
"
+ }
+ ],
+ "summary": "Search users",
+ "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.19/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/search/#search-users"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "search",
+ "subcategory": null
+ },
+ "slug": "search-users",
+ "category": "search",
+ "categoryLabel": "Search",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
\nFor example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
\nThis query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 12,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"login\": \"mojombo\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/mojombo\",\n \"html_url\": \"https://github.com/mojombo\",\n \"followers_url\": \"https://api.github.com/users/mojombo/followers\",\n \"subscriptions_url\": \"https://api.github.com/users/mojombo/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/mojombo/orgs\",\n \"repos_url\": \"https://api.github.com/users/mojombo/repos\",\n \"received_events_url\": \"https://api.github.com/users/mojombo/received_events\",\n \"type\": \"User\",\n \"score\": 1,\n \"following_url\": \"https://api.github.com/users/mojombo/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/mojombo/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\n \"events_url\": \"https://api.github.com/users/mojombo/events{/privacy}\",\n \"site_admin\": true\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ },
+ {
+ "httpStatusCode": "503",
+ "httpStatusMessage": "Service Unavailable",
+ "description": "Service unavailable"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/configcheck",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configcheck
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/configcheck')",
+ "html": "await octokit.request('GET /setup/api/configcheck')\n
"
+ }
+ ],
+ "summary": "Get the configuration status",
+ "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |",
+ "operationId": "enterprise-admin/get-configuration-status",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-the-configuration-status"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-the-configuration-status",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint allows you to check the status of the most recent configuration process:
\nNote that you may need to wait several seconds after you start a process before you can check its status.
\nThe different statuses are:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Status | Description |
|---|
PENDING | The job has not started yet |
CONFIGURING | The job is running |
DONE | The job has finished correctly |
FAILED | The job has finished unexpectedly |
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"status\": \"running\",\n \"progress\": [\n {\n \"status\": \"DONE\",\n \"key\": \"Appliance core components\"\n },\n {\n \"status\": \"DONE\",\n \"key\": \"GitHub utilities\"\n },\n {\n \"status\": \"DONE\",\n \"key\": \"GitHub applications\"\n },\n {\n \"status\": \"CONFIGURING\",\n \"key\": \"GitHub services\"\n },\n {\n \"status\": \"PENDING\",\n \"key\": \"Reloading appliance services\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/configure",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/configure
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/configure')",
+ "html": "await octokit.request('POST /setup/api/configure')\n
"
+ }
+ ],
+ "summary": "Start a configuration process",
+ "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:",
+ "operationId": "enterprise-admin/start-configuration-process",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#start-a-configuration-process"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "start-a-configuration-process",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/maintenance",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/maintenance')",
+ "html": "await octokit.request('GET /setup/api/maintenance')\n
"
+ }
+ ],
+ "summary": "Get the maintenance status",
+ "description": "Check your installation's maintenance status:",
+ "operationId": "enterprise-admin/get-maintenance-status",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-the-maintenance-status"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-the-maintenance-status",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Check your installation's maintenance status:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15 => 34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/maintenance",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/maintenance', {\n maintenance: 'maintenance'\n})",
+ "html": "await octokit.request('POST /setup/api/maintenance', {\n maintenance: 'maintenance'\n})\n
"
+ }
+ ],
+ "summary": "Enable or disable maintenance mode",
+ "description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).",
+ "operationId": "enterprise-admin/enable-or-disable-maintenance-mode",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "maintenance": {
+ "type": "string",
+ "description": "Required. A JSON string with the attributes enabled and when.
",
+ "name": "maintenance",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the attributes `enabled` and `when`.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "maintenance"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "enable-or-disable-maintenance-mode",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "descriptionHTML": "The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.
\nThe possible values for when are now or any date parseable by mojombo/chronic.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. A JSON string with the attributes enabled and when.
",
+ "name": "maintenance",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the attributes `enabled` and `when`.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"status\": \"scheduled\",\n \"scheduled_time\": \"Tuesday, January 22 at 15 => 34 -0800\",\n \"connection_services\": [\n {\n \"name\": \"git operations\",\n \"number\": 0\n },\n {\n \"name\": \"mysql queries\",\n \"number\": 233\n },\n {\n \"name\": \"resque jobs\",\n \"number\": 54\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/settings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/settings')",
+ "html": "await octokit.request('GET /setup/api/settings')\n
"
+ }
+ ],
+ "summary": "Get settings",
+ "description": "",
+ "operationId": "enterprise-admin/get-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-settings"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-settings",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"enterprise\": {\n \"private_mode\": false,\n \"public_pages\": false,\n \"subdomain_isolation\": true,\n \"signup_enabled\": false,\n \"github_hostname\": \"ghe.local\",\n \"identicons_host\": \"dotcom\",\n \"http_proxy\": null,\n \"auth_mode\": \"default\",\n \"expire_sessions\": false,\n \"admin_password\": null,\n \"configuration_id\": 1401777404,\n \"configuration_run_count\": 4,\n \"avatar\": {\n \"enabled\": false,\n \"uri\": \"\"\n },\n \"customer\": {\n \"name\": \"GitHub\",\n \"email\": \"stannis@themannis.biz\",\n \"uuid\": \"af6cac80-e4e1-012e-d822-1231380e52e9\",\n \"secret_key_data\": \"-----BEGIN PGP PRIVATE KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\\n-----END PGP PRIVATE KEY BLOCK-----\\n\",\n \"public_key_data\": \"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"\n },\n \"license\": {\n \"seats\": 0,\n \"evaluation\": false,\n \"perpetual\": false,\n \"unlimited_seating\": true,\n \"support_key\": \"ssh-rsa AAAAB3N....\",\n \"ssh_allowed\": true,\n \"cluster_support\": false,\n \"expire_at\": \"2016-04-27T00:00:00-07:00\"\n },\n \"github_ssl\": {\n \"enabled\": false,\n \"cert\": null,\n \"key\": null\n },\n \"ldap\": {\n \"host\": null,\n \"port\": 0,\n \"base\": [],\n \"uid\": null,\n \"bind_dn\": null,\n \"password\": null,\n \"method\": \"Plain\",\n \"search_strategy\": \"detect\",\n \"user_groups\": [],\n \"admin_group\": null,\n \"virtual_attribute_enabled\": false,\n \"recursive_group_search\": false,\n \"posix_support\": true,\n \"user_sync_emails\": false,\n \"user_sync_keys\": false,\n \"user_sync_interval\": 4,\n \"team_sync_interval\": 4,\n \"sync_enabled\": false,\n \"reconciliation\": {\n \"user\": null,\n \"org\": null\n },\n \"profile\": {\n \"uid\": \"uid\",\n \"name\": null,\n \"mail\": null,\n \"key\": null\n }\n },\n \"cas\": {\n \"url\": null\n },\n \"saml\": {\n \"sso_url\": null,\n \"certificate\": null,\n \"certificate_path\": null,\n \"issuer\": null,\n \"idp_initiated_sso\": false,\n \"disable_admin_demote\": false\n },\n \"github_oauth\": {\n \"client_id\": \"12313412\",\n \"client_secret\": \"kj123131132\",\n \"organization_name\": \"Homestar Runners\",\n \"organization_team\": \"homestarrunners/characters\"\n },\n \"smtp\": {\n \"enabled\": true,\n \"address\": \"smtp.example.com\",\n \"authentication\": \"plain\",\n \"port\": \"1234\",\n \"domain\": \"blah\",\n \"username\": \"foo\",\n \"user_name\": \"mr_foo\",\n \"enable_starttls_auto\": true,\n \"password\": \"bar\",\n \"discard-to-noreply-address\": true,\n \"support_address\": \"enterprise@github.com\",\n \"support_address_type\": \"email\",\n \"noreply_address\": \"noreply@github.com\"\n },\n \"ntp\": {\n \"primary_server\": \"0.pool.ntp.org\",\n \"secondary_server\": \"1.pool.ntp.org\"\n },\n \"timezone\": null,\n \"snmp\": {\n \"enabled\": false,\n \"community\": \"\"\n },\n \"syslog\": {\n \"enabled\": false,\n \"server\": null,\n \"protocol_name\": \"udp\"\n },\n \"assets\": null,\n \"pages\": {\n \"enabled\": true\n },\n \"collectd\": {\n \"enabled\": false,\n \"server\": null,\n \"port\": 0,\n \"encryption\": null,\n \"username\": null,\n \"password\": null\n },\n \"mapping\": {\n \"enabled\": true,\n \"tileserver\": null,\n \"basemap\": \"company.map-qsz2zrvs\",\n \"token\": null\n },\n \"load_balancer\": null\n },\n \"run_list\": [\n \"recipe[enterprise-configure]\"\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/setup/api/settings",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /setup/api/settings', {\n settings: 'settings'\n})",
+ "html": "await octokit.request('PUT /setup/api/settings', {\n settings: 'settings'\n})\n
"
+ }
+ ],
+ "summary": "Set settings",
+ "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-settings).",
+ "operationId": "enterprise-admin/set-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#set-settings"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "settings": {
+ "type": "string",
+ "description": "Required. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "settings"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "set-settings",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "For a list of the available settings, see the Get settings endpoint.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/setup/api/settings/authorized-keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /setup/api/settings/authorized-keys')",
+ "html": "await octokit.request('GET /setup/api/settings/authorized-keys')\n
"
+ }
+ ],
+ "summary": "Get all authorized SSH keys",
+ "description": "",
+ "operationId": "enterprise-admin/get-all-authorized-ssh-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-all-authorized-ssh-keys"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "get-all-authorized-ssh-keys",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/settings/authorized-keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})",
+ "html": "await octokit.request('POST /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})\n
"
+ }
+ ],
+ "summary": "Add an authorized SSH key",
+ "description": "",
+ "operationId": "enterprise-admin/add-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#add-an-authorized-ssh-key"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "add-an-authorized-ssh-key",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/setup/api/settings/authorized-keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})",
+ "html": "await octokit.request('DELETE /setup/api/settings/authorized-keys', {\n authorized_key: 'authorized_key'\n})\n
"
+ }
+ ],
+ "summary": "Remove an authorized SSH key",
+ "description": "",
+ "operationId": "enterprise-admin/remove-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#remove-an-authorized-ssh-key"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "remove-an-authorized-ssh-key",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The path to the public SSH key.
",
+ "name": "authorized_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The path to the public SSH key.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n },\n {\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\n \"pretty-print\": \"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/start",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/start', {\n license: 'license'\n})",
+ "html": "await octokit.request('POST /setup/api/start', {\n license: 'license'\n})\n
"
+ }
+ ],
+ "summary": "Create a GitHub license",
+ "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-settings).",
+ "operationId": "enterprise-admin/create-enterprise-server-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-github-enterprise-server-license"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "Required. The content of your .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your _.ghl_ license file.",
+ "childParamsGroups": []
+ },
+ "password": {
+ "type": "string",
+ "description": "You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.",
+ "childParamsGroups": []
+ },
+ "settings": {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An optional JSON string containing the installation settings.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "license"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "create-a-github-license",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "descriptionHTML": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\n\n- If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.
\n- If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.
\n
\nFor a list of the available settings, see the Get settings endpoint.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The content of your .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your _.ghl_ license file.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
",
+ "name": "password",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings.
",
+ "name": "settings",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "An optional JSON string containing the installation settings.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/setup/api/upgrade",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/setup/api/upgrade \\\n -d '{\"license\":\"license\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /setup/api/upgrade', {\n license: 'license'\n})",
+ "html": "await octokit.request('POST /setup/api/upgrade', {\n license: 'license'\n})\n
"
+ }
+ ],
+ "summary": "Upgrade a license",
+ "description": "This API upgrades your license and also triggers the configuration process:",
+ "operationId": "enterprise-admin/upgrade-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#upgrade-a-license"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your new .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your new _.ghl_ license file.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ },
+ "slug": "upgrade-a-license",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "management-console",
+ "subcategoryLabel": "Management console",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "202",
+ "httpStatusMessage": "Accepted",
+ "description": "Response"
+ }
+ ],
+ "descriptionHTML": "This API upgrades your license and also triggers the configuration process:
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The content of your new .ghl license file.
",
+ "name": "license",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The content of your new _.ghl_ license file.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a team",
+ "description": "",
+ "operationId": "teams/get",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#get-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "get-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/teams/{team_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42 \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /teams/{team_id}', {\n team_id: 42,\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /teams/{team_id}', {\n team_id: 42,\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update a team",
+ "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.",
+ "operationId": "teams/update",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#update-a-team"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the team.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the team.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor 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.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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.",
+ "childParamsGroups": []
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "update-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "descriptionHTML": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The name of the team.
",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The description of the team.
",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The description of the team.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor 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.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
",
+ "enum": [
+ "secret",
+ "closed"
+ ],
+ "name": "privacy",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ },
+ {
+ "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",
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "**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.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.
",
+ "name": "parent_team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}', {\n team_id: 42\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a team",
+ "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well.",
+ "operationId": "teams/delete",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#delete-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "delete-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner and you pass the hellcat-preview media type, deleting a parent team will delete all of its child teams as well.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "direction",
+ "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List discussions",
+ "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/list-discussions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#list-discussions"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "list-discussions",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 0,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": null,\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Our first team post\",\n \"updated_at\": \"2018-01-25T18:56:31Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions', {\n team_id: 42,\n title: 'title',\n body: 'body'\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions', {\n team_id: 42,\n title: 'title',\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a discussion",
+ "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "teams/create-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-discussion"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Required. The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "Required. The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ },
+ "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,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ]
+ },
+ "example": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "create-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "descriptionHTML": "Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "Required. The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ },
+ {
+ "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,
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 0,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": null,\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Our first team post\",\n \"updated_at\": \"2018-01-25T18:56:31Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a discussion",
+ "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/get-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#get-a-discussion"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "get-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 0,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": null,\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Our first team post\",\n \"updated_at\": \"2018-01-25T18:56:31Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42 \\\n -d '{\"title\":\"title\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n title: 'title'\n})",
+ "html": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42,\n title: 'title'\n})\n
"
+ }
+ ],
+ "summary": "Update a discussion",
+ "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/update-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#update-a-discussion"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ }
+ }
+ },
+ "example": {
+ "title": "Welcome to our first team post"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "update-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The discussion post's title.
",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's title.",
+ "childParamsGroups": []
+ },
+ {
+ "type": "string",
+ "description": "The discussion post's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion post's body text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n \"comments_count\": 1,\n \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n \"created_at\": \"2018-01-25T18:56:31Z\",\n \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n \"number\": 1,\n \"pinned\": false,\n \"private\": false,\n \"team_url\": \"https://api.github.com/teams/2343027\",\n \"title\": \"Welcome to our first team post\",\n \"updated_at\": \"2018-01-26T18:22:20Z\",\n \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}', {\n team_id: 42,\n discussion_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a discussion",
+ "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/delete-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#delete-a-discussion"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": "discussions"
+ },
+ "slug": "delete-a-discussion",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussions",
+ "subcategoryLabel": "Discussions",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "direction",
+ "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List discussion comments",
+ "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/list-discussion-comments",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#list-discussion-comments"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "list-discussion-comments",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like apples?\",\n \"body_html\": \"<p>Do you like apples?</p>\",\n \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": null,\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-15T23:53:58Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments', {\n team_id: 42,\n discussion_number: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Create a discussion comment",
+ "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "teams/create-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-discussion-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Do you like apples?"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "create-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "descriptionHTML": "Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" for details.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like apples?\",\n \"body_html\": \"<p>Do you like apples?</p>\",\n \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": null,\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-15T23:53:58Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a discussion comment",
+ "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/get-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#get-a-discussion-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "get-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like apples?\",\n \"body_html\": \"<p>Do you like apples?</p>\",\n \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": null,\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-15T23:53:58Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n body: 'body'\n})",
+ "html": "await octokit.request('PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n body: 'body'\n})\n
"
+ }
+ ],
+ "summary": "Update a discussion comment",
+ "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/update-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#update-a-discussion-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Do you like pineapples?"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "update-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "descriptionHTML": "Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The discussion comment's body text.
",
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The discussion comment's body text.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"body\": \"Do you like pineapples?\",\n \"body_html\": \"<p>Do you like pineapples?</p>\",\n \"body_version\": \"e6907b24d9c93cc0c5024a7af5888116\",\n \"created_at\": \"2018-01-15T23:53:58Z\",\n \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n \"number\": 1,\n \"updated_at\": \"2018-01-26T18:22:20Z\",\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n \"reactions\": {\n \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n \"total_count\": 5,\n \"+1\": 3,\n \"-1\": 1,\n \"laugh\": 0,\n \"confused\": 0,\n \"heart\": 1,\n \"hooray\": 0,\n \"eyes\": 1,\n \"rocket\": 1\n }\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a discussion comment",
+ "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/delete-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#delete-a-discussion-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ },
+ "slug": "delete-a-discussion-comment",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "discussion-comments",
+ "subcategoryLabel": "Discussion comments",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a team discussion comment",
+ "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "reactions/list-for-team-discussion-comment",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#list-reactions-for-a-team-discussion-comment"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions"
+ },
+ "slug": "list-reactions-for-a-team-discussion-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n content: 'content'\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n comment_number: 42,\n content: 'content'\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a team discussion comment",
+ "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
+ "operationId": "reactions/create-for-team-discussion-comment",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#create-reaction-for-a-team-discussion-comment"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the team discussion comment.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions"
+ },
+ "slug": "create-reaction-for-a-team-discussion-comment",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion comment.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the team discussion comment.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ },
+ "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42\n})\n
"
+ }
+ ],
+ "summary": "List reactions for a team discussion",
+ "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "reactions/list-for-team-discussion",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#list-reactions-for-a-team-discussion"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions"
+ },
+ "slug": "list-reactions-for-a-team-discussion",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n content: 'content'\n})",
+ "html": "await octokit.request('POST /teams/{team_id}/discussions/{discussion_number}/reactions', {\n team_id: 42,\n discussion_number: 42,\n content: 'content'\n})\n
"
+ }
+ ],
+ "summary": "Create reaction for a team discussion",
+ "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.",
+ "operationId": "reactions/create-for-team-discussion",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/reactions/#create-reaction-for-a-team-discussion"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the team discussion.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions) reactions.",
+ "html": "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 for full details.
\nTo access the API you must provide a custom media type in the Accept header:
\napplication/vnd.github.squirrel-girl-preview
\nThe reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.
"
+ }
+ ],
+ "category": "reactions"
+ },
+ "slug": "create-reaction-for-a-team-discussion",
+ "category": "reactions",
+ "categoryLabel": "Reactions",
+ "notes": [],
+ "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The reaction type to add to the team discussion.
",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ],
+ "name": "content",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types) to add to the team discussion.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/members",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Filters members returned by their role in the team. Can be one of:
\n* member - normal members of the team.
\n* maintainer - team maintainers.
\n* all - all members of the team.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/members', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/members', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List team members",
+ "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "operationId": "teams/list-members",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#list-team-members"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "list-team-members",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If you pass the hellcat-preview media type, team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get team member (Legacy)",
+ "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#get-team-member-legacy"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true,
+ "slug": "get-team-member-legacy",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if user is a member"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if user is not a member"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "The \"Get team member\" endpoint (described below) is deprecated.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
"
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Add team member (Legacy)",
+ "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server 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 Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#add-team-member-legacy"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true,
+ "slug": "add-team-member-legacy",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if team synchronization is set up"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if you attempt to add an organization to a team",
+ "payload": "{\n \"message\": \"Cannot add an organization as a member.\",\n \"errors\": [\n {\n \"code\": \"org\",\n \"field\": \"user\",\n \"resource\": \"TeamMember\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "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",
+ "payload": "{\n \"message\": \"User isn't a member of this organization. Please invite them first.\",\n \"errors\": [\n {\n \"code\": \"unaffiliated\",\n \"field\": \"user\",\n \"resource\": \"TeamMember\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/members/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/members/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/members/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove team member (Legacy)",
+ "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server 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 Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#remove-team-member-legacy"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "removalDate": "2021-02-01",
+ "deprecationDate": "2020-01-21",
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "deprecated": true,
+ "slug": "remove-team-member-legacy",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if team synchronization is setup"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "The \"Remove team member\" endpoint (described below) is deprecated.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get team membership for a user",
+ "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.19/rest/reference/teams#create-a-team).",
+ "operationId": "teams/get-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#get-team-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "get-team-membership-for-a-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If you pass the hellcat-preview media type, team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has an active membership with team",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"active\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user is a team maintainer",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"maintainer\",\n \"state\": \"active\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user has a pending membership with team",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"pending\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username',\n role: 'role'\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username',\n role: 'role'\n})\n
"
+ }
+ ],
+ "summary": "Add or update team membership for a user",
+ "description": "If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.",
+ "operationId": "teams/add-or-update-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#add-or-update-team-membership-for-a-user"
+ },
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "add-or-update-team-membership-for-a-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "descriptionHTML": "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.
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
",
+ "bodyParameters": [
+ {
+ "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",
+ "name": "role",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "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.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user's membership with team is now active",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"active\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if user's membership with team is now pending",
+ "payload": "{\n \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n \"role\": \"member\",\n \"state\": \"pending\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Response if you attempt to add an organization to a team",
+ "payload": "{\n \"message\": \"Cannot add an organization as a member.\",\n \"errors\": [\n {\n \"code\": \"org\",\n \"field\": \"user\",\n \"resource\": \"TeamMember\"\n }\n ]\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/memberships/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/memberships/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/memberships/{username}', {\n team_id: 42,\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.",
+ "operationId": "teams/remove-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/teams#remove-team-membership-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": "members"
+ },
+ "slug": "remove-team-membership-for-a-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/projects', {\n team_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/projects', {\n team_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List team projects",
+ "description": "Lists the organization projects for a team. If you are an [authenticated](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#authentication) site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
+ "operationId": "teams/list-projects",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#list-team-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-team-projects",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the organization projects for a team. If you are an authenticated site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/orgs/octocat\",\n \"url\": \"https://api.github.com/projects/1002605\",\n \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n \"id\": 1002605,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n \"name\": \"Organization Roadmap\",\n \"body\": \"High-level roadmap for the upcoming year.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-11T20:09:31Z\",\n \"updated_at\": \"2014-03-04T18:58:10Z\",\n \"organization_permission\": \"write\",\n \"private\": false,\n \"permissions\": {\n \"read\": true,\n \"write\": true,\n \"admin\": false\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Check team permissions for a project",
+ "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
+ "operationId": "teams/check-permissions-for-project",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#check-team-permissions-for-a-project"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "check-team-permissions-for-a-project",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Checks whether a team has read, write, or admin permissions for an organization project. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/orgs/octocat\",\n \"url\": \"https://api.github.com/projects/1002605\",\n \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n \"id\": 1002605,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n \"name\": \"Organization Roadmap\",\n \"body\": \"High-level roadmap for the upcoming year.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-11T20:09:31Z\",\n \"updated_at\": \"2014-03-04T18:58:10Z\",\n \"organization_permission\": \"write\",\n \"private\": false,\n \"permissions\": {\n \"read\": true,\n \"write\": true,\n \"admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if project is not managed by this team"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/teams/42/projects/42 \\\n -d '{\"permission\":\"permission\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42,\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "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.",
+ "operationId": "teams/add-or-update-project-permissions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#add-or-update-team-project-permissions"
+ },
+ "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.\"
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited from a parent team.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "add-or-update-team-project-permissions",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "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.\"
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited from a parent team.
",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Response if the project is not owned by the organization",
+ "payload": "{\n \"message\": \"Must have admin rights to Repository.\",\n \"documentation_url\": \"https://docs.github.com/enterprise-server@2.19/rest/reference/teams#add-or-update-team-project-permissions\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/projects/{project_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/projects/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/projects/{project_id}', {\n team_id: 42,\n project_id: 42\n})\n
"
+ }
+ ],
+ "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. **Note:** This endpoint removes the project from the team, but does not delete it.",
+ "operationId": "teams/remove-project",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#remove-a-project-from-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "remove-a-project-from-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/repos', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/repos', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List team repositories",
+ "description": "**Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team.\n\nIf you are an [authenticated](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#authentication) site administrator for your Enterprise instance, you will be able to list all repositories for the team.",
+ "operationId": "teams/list-repos",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#list-team-repositories"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-team-repositories",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: If you pass the hellcat-preview media type, the response will include any repositories inherited through a parent team.
\nIf you are an authenticated site administrator for your Enterprise instance, you will be able to list all repositories for the team.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Check team permissions for a repository",
+ "description": "**Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/) via the `Accept` header:",
+ "operationId": "teams/check-permissions-for-repo",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#check-team-permissions-for-a-repository"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "check-team-permissions-for-a-repository",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Alternative response with extra repository information"
+ },
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if repository is managed by this team"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if repository is not managed by this team"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note: If you pass the hellcat-preview media type, repositories inherited through a parent team will be checked.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
"
+ },
+ {
+ "verb": "put",
+ "requestPath": "/teams/{team_id}/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world',\n permission: 'permission'\n})",
+ "html": "await octokit.request('PUT /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world',\n permission: 'permission'\n})\n
"
+ }
+ ],
+ "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.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "teams/add-or-update-repo-permissions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#add-or-update-team-repository-permissions"
+ },
+ "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.
\nIf no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited through a parent team.
",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "add-or-update-team-repository-permissions",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "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.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "bodyParameters": [
+ {
+ "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.
\nIf no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
\nNote: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited through a parent team.
",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "name": "permission",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/teams/{team_id}/repos/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/repos/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /teams/{team_id}/repos/{owner}/{repo}', {\n team_id: 42,\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "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. NOTE: This does not delete the repository, it just removes it from the team.",
+ "operationId": "teams/remove-repo",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#remove-a-repository-from-a-team"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "remove-a-repository-from-a-team",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/teams/{team_id}/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/teams/42/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /teams/{team_id}/teams', {\n team_id: 42\n})",
+ "html": "await octokit.request('GET /teams/{team_id}/teams', {\n team_id: 42\n})\n
"
+ }
+ ],
+ "summary": "List child teams",
+ "description": "You must use the `hellcat-preview` media type to use this endpoint.",
+ "operationId": "teams/list-child",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#list-child-teams"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```",
+ "html": "The Nested Teams API is currently available for developers to preview. See the blog post for full details. To access the API, you must provide a custom media type in the Accept header:
\napplication/vnd.github.hellcat-preview+json
"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-child-teams",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "You must use the hellcat-preview media type to use this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response if child teams exist",
+ "payload": "[\n {\n \"id\": 2,\n \"node_id\": \"MDQ6VGVhbTI=\",\n \"url\": \"https://api.github.com/teams/2\",\n \"name\": \"Original Roster\",\n \"slug\": \"original-roster\",\n \"description\": \"Started it all.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/2/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/2/repos\",\n \"parent\": {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n },\n \"html_url\": \"https://github.com/orgs/rails/teams/core\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user')",
+ "html": "await octokit.request('GET /user')\n
"
+ }
+ ],
+ "summary": "Get the authenticated user",
+ "description": "If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.\n\nIf the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/users/#get-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "get-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "If the authenticated user is authenticated through basic authentication or OAuth with the user scope, then the response lists public and private profile information.
\nIf the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with public and private profile information",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\",\n \"private_gists\": 81,\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"two_factor_authentication\": true,\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"collaborators\": 0\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with public profile information",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/user",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /user', {\n name: 'name'\n})",
+ "html": "await octokit.request('PATCH /user', {\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Update the authenticated user",
+ "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/update-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/users/#update-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The new name of the user.
",
+ "type": "string",
+ "example": "Omar Jahandar",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new name of the user.",
+ "childParamsGroups": []
+ },
+ "email": {
+ "description": "The publicly visible email address of the user.
",
+ "type": "string",
+ "example": "omar@example.com",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address of the user.",
+ "childParamsGroups": []
+ },
+ "blog": {
+ "description": "The new blog URL of the user.
",
+ "type": "string",
+ "example": "blog.example.com",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blog URL of the user.",
+ "childParamsGroups": []
+ },
+ "twitter_username": {
+ "description": "The new Twitter username of the user.
",
+ "type": "string or null",
+ "example": "therealomarj",
+ "nullable": true,
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new Twitter username of the user.",
+ "childParamsGroups": []
+ },
+ "company": {
+ "description": "The new company of the user.
",
+ "type": "string",
+ "example": "Acme corporation",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new company of the user.",
+ "childParamsGroups": []
+ },
+ "location": {
+ "description": "The new location of the user.
",
+ "type": "string",
+ "example": "Berlin, Germany",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new location of the user.",
+ "childParamsGroups": []
+ },
+ "hireable": {
+ "description": "The new hiring availability of the user.
",
+ "type": "boolean",
+ "name": "hireable",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "The new hiring availability of the user.",
+ "childParamsGroups": []
+ },
+ "bio": {
+ "description": "The new short biography of the user.
",
+ "type": "string",
+ "name": "bio",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new short biography of the user.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "update-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "The new name of the user.
",
+ "type": "string",
+ "example": "Omar Jahandar",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new name of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The publicly visible email address of the user.
",
+ "type": "string",
+ "example": "omar@example.com",
+ "name": "email",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The publicly visible email address of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new blog URL of the user.
",
+ "type": "string",
+ "example": "blog.example.com",
+ "name": "blog",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new blog URL of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new Twitter username of the user.
",
+ "type": "string or null",
+ "example": "therealomarj",
+ "nullable": true,
+ "name": "twitter_username",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new Twitter username of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new company of the user.
",
+ "type": "string",
+ "example": "Acme corporation",
+ "name": "company",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new company of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new location of the user.
",
+ "type": "string",
+ "example": "Berlin, Germany",
+ "name": "location",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new location of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new hiring availability of the user.
",
+ "type": "boolean",
+ "name": "hireable",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "The new hiring availability of the user.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The new short biography of the user.
",
+ "type": "string",
+ "name": "bio",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The new short biography of the user.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\",\n \"private_gists\": 81,\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"two_factor_authentication\": true,\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"collaborators\": 0\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/emails')",
+ "html": "await octokit.request('GET /user/emails')\n
"
+ }
+ ],
+ "summary": "List email addresses for the authenticated user",
+ "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-emails-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-email-addresses-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "list-email-addresses-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"email\": \"octocat@github.com\",\n \"verified\": true,\n \"primary\": true,\n \"visibility\": \"public\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})",
+ "html": "await octokit.request('POST /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Add an email address for the authenticated user",
+ "description": "This endpoint is accessible with the `user` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/add-email-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#add-an-email-address-for-the-authenticated-user"
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "add-an-email-address-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint is accessible with the user scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "[\n {\n \"email\": \"octocat@octocat.org\",\n \"primary\": false,\n \"verified\": false,\n \"visibility\": \"public\"\n },\n {\n \"email\": \"octocat@github.com\",\n \"primary\": false,\n \"verified\": false,\n \"visibility\": null\n },\n {\n \"email\": \"mona@github.com\",\n \"primary\": false,\n \"verified\": false,\n \"visibility\": null\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/emails \\\n -d '{\"emails\":[\"octocat@github.com\"]}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})",
+ "html": "await octokit.request('DELETE /user/emails', {\n emails: [\n 'octocat@github.com'\n ]\n})\n
"
+ }
+ ],
+ "summary": "Delete an email address for the authenticated user",
+ "description": "This endpoint is accessible with the `user` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-email-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "delete-an-email-address-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This endpoint is accessible with the user scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/followers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/followers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/followers')",
+ "html": "await octokit.request('GET /user/followers')\n
"
+ }
+ ],
+ "summary": "List followers of the authenticated user",
+ "description": "Lists the people following the authenticated user.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followers-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-followers-of-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-followers-of-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people following the authenticated user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/following",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/following')",
+ "html": "await octokit.request('GET /user/following')\n
"
+ }
+ ],
+ "summary": "List the people the authenticated user follows",
+ "description": "Lists the people who the authenticated user follows.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followed-by-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-the-people-the-authenticated-user-follows"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-the-people-the-authenticated-user-follows",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people who the authenticated user follows.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/following/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/following/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /user/following/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Check if a person is followed by the authenticated user",
+ "description": "",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-person-is-followed-by-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "check-if-a-person-is-followed-by-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if the person is followed by the authenticated user"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if the person is not followed by the authenticated user"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/user/following/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /user/following/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /user/following/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Follow a user",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/follow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#follow-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "follow-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/following/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/following/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/following/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /user/following/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Unfollow a user",
+ "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/unfollow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#unfollow-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "unfollow-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/gpg_keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/gpg_keys')",
+ "html": "await octokit.request('GET /user/gpg_keys')\n
"
+ }
+ ],
+ "summary": "List GPG keys for the authenticated user",
+ "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "list-gpg-keys-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"raw_key\": \"string\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/gpg_keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys \\\n -d '{\"armored_public_key\":\"armored_public_key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/gpg_keys', {\n armored_public_key: 'armored_public_key'\n})",
+ "html": "await octokit.request('POST /user/gpg_keys', {\n armored_public_key: 'armored_public_key'\n})\n
"
+ }
+ ],
+ "summary": "Create a GPG key for the authenticated user",
+ "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "users/create-gpg-key-for-authenticated",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#create-a-gpg-key-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "armored_public_key": {
+ "description": "Required. A GPG key in ASCII-armored format.
",
+ "type": "string",
+ "name": "armored_public_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A GPG key in ASCII-armored format.",
+ "childParamsGroups": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "armored_public_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "create-a-gpg-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "Required. A GPG key in ASCII-armored format.
",
+ "type": "string",
+ "name": "armored_public_key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A GPG key in ASCII-armored format.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"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-----\\\"\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/gpg_keys/{gpg_key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "gpg_key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})",
+ "html": "await octokit.request('GET /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a GPG key for the authenticated user",
+ "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-gpg-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "get-a-gpg-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"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-----\\\"\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/gpg_keys/{gpg_key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "gpg_key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/gpg_keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})",
+ "html": "await octokit.request('DELETE /user/gpg_keys/{gpg_key_id}', {\n gpg_key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a GPG key for the authenticated user",
+ "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-gpg-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "delete-a-gpg-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/installations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/installations', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /user/installations', {\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List app installations accessible to the user access token",
+ "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "list-app-installations-accessible-to-the-user-access-token",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.
\nYou must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
\nYou can find the permissions for the installation under the permissions key.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 2,\n \"installations\": [\n {\n \"id\": 1,\n \"account\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"single_file_name\": \"config.yaml\",\n \"repository_selection\": \"all\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app_slug\": \"github-actions\"\n },\n {\n \"id\": 3,\n \"account\": {\n \"login\": \"octocat\",\n \"id\": 2,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"single_file_name\": \"config.yaml\",\n \"repository_selection\": \"all\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app_slug\": \"github-actions\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/installations/{installation_id}/repositories",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/installations/{installation_id}/repositories', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /user/installations/{installation_id}/repositories', {\n installation_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List repositories accessible to the user access token",
+ "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installation-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#list-repositories-accessible-to-the-user-access-token"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ },
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```",
+ "html": "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 in the Accept header:
\napplication/vnd.github.mercy-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "list-repositories-accessible-to-the-user-access-token",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
\nYou must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe access the user has to each repository is included in the hash under the permissions key.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"total_count\": 1,\n \"repositories\": [\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('PUT /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Add a repository to an app installation",
+ "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/add-repo-to-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#add-a-repository-to-an-app-installation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "add-a-repository-to-an-app-installation",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Add a single repository to an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or the OAuth Authorizations API or Basic Authentication to access this endpoint.
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/installations/{installation_id}/repositories/{repository_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "installation_id parameter
"
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/user/installations/42/repositories/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('DELETE /user/installations/{installation_id}/repositories/{repository_id}', {\n installation_id: 42,\n repository_id: 42,\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Remove a repository from an app installation",
+ "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/remove-repo-from-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#remove-a-repository-from-an-app-installation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ },
+ "slug": "remove-a-repository-from-an-app-installation",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "subcategory": "installations",
+ "subcategoryLabel": "Installations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or the OAuth Authorizations API or Basic Authentication to access this endpoint.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/issues",
+ "serverUrl": "https://api.github.com",
+ "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"
+ },
+ "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation
"
+ },
+ {
+ "name": "state",
+ "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "closed",
+ "all"
+ ],
+ "default": "open"
+ },
+ "descriptionHTML": "Indicates the state of the issues to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
"
+ },
+ {
+ "name": "sort",
+ "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "comments"
+ ],
+ "default": "created"
+ },
+ "descriptionHTML": "What to sort results by. Can be either created, updated, comments.
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/issues
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/issues')",
+ "html": "await octokit.request('GET /user/issues')\n
"
+ }
+ ],
+ "summary": "List user account issues assigned to the authenticated user",
+ "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```",
+ "html": "If an issue event is created via a GitHub App, the response will include the performed_via_github_app object with\tinformation about the GitHub App. For more information, see the related blog\tpost.\nTo receive the performed_via_github_app object in the response, you must provide a custom media type in the Accept header:
\napplication/vnd.github.machine-man-preview
"
+ }
+ ],
+ "category": "issues"
+ },
+ "slug": "list-user-account-issues-assigned-to-the-authenticated-user",
+ "category": "issues",
+ "categoryLabel": "Issues",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List issues across owned and member repositories assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDU6SXNzdWUx\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n \"number\": 1347,\n \"state\": \"open\",\n \"title\": \"Found a bug\",\n \"body\": \"I'm having a problem with this.\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 208045946,\n \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n \"name\": \"bug\",\n \"description\": \"Something isn't working\",\n \"color\": \"f29513\",\n \"default\": true\n }\n ],\n \"assignee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assignees\": [\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n ],\n \"milestone\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n \"id\": 1002604,\n \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n \"number\": 1,\n \"state\": \"open\",\n \"title\": \"v1.0\",\n \"description\": \"Tracking milestone for version 1.0\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"open_issues\": 4,\n \"closed_issues\": 8,\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"closed_at\": \"2013-02-12T13:22:01Z\",\n \"due_on\": \"2012-10-09T23:39:01Z\"\n },\n \"locked\": true,\n \"active_lock_reason\": \"too heated\",\n \"comments\": 0,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n },\n \"closed_at\": null,\n \"created_at\": \"2011-04-22T13:33:48Z\",\n \"updated_at\": \"2011-04-22T13:33:48Z\",\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/keys')",
+ "html": "await octokit.request('GET /user/keys')\n
"
+ }
+ ],
+ "summary": "List public SSH keys for the authenticated user",
+ "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "list-public-ssh-keys-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"id\": 2,\n \"url\": \"https://api.github.com/user/keys/2\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAA\",\n \"created_at\": \"2020-06-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n },\n {\n \"key_id\": \"012345678912345608\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\n \"id\": 3,\n \"url\": \"https://api.github.com/user/keys/3\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAB\",\n \"created_at\": \"2020-07-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys \\\n -d '{\"key\":\"key\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/keys', {\n key: 'key'\n})",
+ "html": "await octokit.request('POST /user/keys', {\n key: 'key'\n})\n
"
+ }
+ ],
+ "summary": "Create a public SSH key for the authenticated user",
+ "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "users/create-public-ssh-key-for-authenticated",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "A descriptive name for the new key.
",
+ "type": "string",
+ "example": "Personal MacBook Air",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A descriptive name for the new key.",
+ "childParamsGroups": []
+ },
+ "key": {
+ "description": "Required. The public SSH key to add to your GitHub account.
",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The public SSH key to add to your GitHub account.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "create-a-public-ssh-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "descriptionHTML": "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.
",
+ "bodyParameters": [
+ {
+ "description": "A descriptive name for the new key.
",
+ "type": "string",
+ "example": "Personal MacBook Air",
+ "name": "title",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A descriptive name for the new key.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Required. The public SSH key to add to your GitHub account.
",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ",
+ "name": "key",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The public SSH key to add to your GitHub account.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"id\": 2,\n \"url\": \"https://api.github.com/user/keys/2\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAA\",\n \"created_at\": \"2020-06-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/keys/{key_id}', {\n key_id: 42\n})",
+ "html": "await octokit.request('GET /user/keys/{key_id}', {\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Get a public SSH key for the authenticated user",
+ "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-public-ssh-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "get-a-public-ssh-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"key_id\": \"012345678912345678\",\n \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\n \"id\": 2,\n \"url\": \"https://api.github.com/user/keys/2\",\n \"title\": \"ssh-rsa AAAAB3NzaC1yc2EAAA\",\n \"created_at\": \"2020-06-11T21:31:57Z\",\n \"verified\": false,\n \"read_only\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/keys/{key_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "key_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/keys/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/keys/{key_id}', {\n key_id: 42\n})",
+ "html": "await octokit.request('DELETE /user/keys/{key_id}', {\n key_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Delete a public SSH key for the authenticated user",
+ "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "delete-a-public-ssh-key-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/memberships/orgs",
+ "serverUrl": "https://api.github.com",
+ "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"
+ ]
+ },
+ "descriptionHTML": "Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/memberships/orgs')",
+ "html": "await octokit.request('GET /user/memberships/orgs')\n
"
+ }
+ ],
+ "summary": "List organization memberships for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-memberships-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "list-organization-memberships-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n },\n {\n \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n \"state\": \"pending\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/memberships/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/memberships/orgs/{org}', {\n org: 'org'\n})",
+ "html": "await octokit.request('GET /user/memberships/orgs/{org}', {\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "Get an organization membership for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "get-an-organization-membership-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n \"state\": \"pending\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/user/memberships/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/memberships/orgs/ORG \\\n -d '{\"state\":\"state\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /user/memberships/orgs/{org}', {\n org: 'org',\n state: 'state'\n})",
+ "html": "await octokit.request('PATCH /user/memberships/orgs/{org}', {\n org: 'org',\n state: 'state'\n})\n
"
+ }
+ ],
+ "summary": "Update an organization membership for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "Required. The state that the membership should be in. Only \"active\" will be accepted.
",
+ "enum": [
+ "active"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "state": "active"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "members"
+ },
+ "slug": "update-an-organization-membership-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "subcategory": "members",
+ "subcategoryLabel": "Members",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "Required. The state that the membership should be in. Only \"active\" will be accepted.
",
+ "enum": [
+ "active"
+ ],
+ "name": "state",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The state that the membership should be in. Only `\"active\"` will be accepted.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n \"state\": \"active\",\n \"role\": \"admin\",\n \"organization_url\": \"https://api.github.com/orgs/octocat\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n },\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/orgs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/orgs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/orgs')",
+ "html": "await octokit.request('GET /user/orgs')\n
"
+ }
+ ],
+ "summary": "List organizations for the authenticated user",
+ "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/orgs/#list-organizations-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "list-organizations-for-the-authenticated-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List organizations for the authenticated user.
\nOAuth scope requirements
\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/user/projects \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/projects', {\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('POST /user/projects', {\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Create a user project",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#create-a-user-project"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Required. Name of the project
",
+ "example": "Week One Sprint",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project",
+ "childParamsGroups": []
+ },
+ "body": {
+ "description": "Body of the project
",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string or null",
+ "nullable": true,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Body of the project",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "create-a-user-project",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "descriptionHTML": "",
+ "bodyParameters": [
+ {
+ "description": "Required. Name of the project
",
+ "example": "Week One Sprint",
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Name of the project",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Body of the project
",
+ "example": "This project represents the sprint of the first week in January",
+ "type": "string or null",
+ "nullable": true,
+ "name": "body",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "Body of the project",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"owner_url\": \"https://api.github.com/users/octocat\",\n \"url\": \"https://api.github.com/projects/1002603\",\n \"html_url\": \"https://github.com/users/octocat/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002603/columns\",\n \"id\": 1002603,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDM=\",\n \"name\": \"My Projects\",\n \"body\": \"A board to manage my personal projects.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/public_emails",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/public_emails
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/public_emails')",
+ "html": "await octokit.request('GET /user/public_emails')\n
"
+ }
+ ],
+ "summary": "List public email addresses for the authenticated user",
+ "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@2.19/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-emails-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": "emails"
+ },
+ "slug": "list-public-email-addresses-for-the-authenticated-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "emails",
+ "subcategoryLabel": "Emails",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"email\": \"octocat@github.com\",\n \"verified\": true,\n \"primary\": true,\n \"visibility\": \"public\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/repos",
+ "serverUrl": "https://api.github.com",
+ "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"
+ },
+ "descriptionHTML": "Can be one of all, public, or private.
"
+ },
+ {
+ "name": "affiliation",
+ "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "owner,collaborator,organization_member"
+ },
+ "descriptionHTML": "Comma-separated list of values. Can include:
\n* owner: Repositories that are owned by the authenticated user.
\n* collaborator: Repositories that the user has been added to as a collaborator.
\n* organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
"
+ },
+ {
+ "name": "type",
+ "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "owner",
+ "public",
+ "private",
+ "member"
+ ],
+ "default": "all"
+ },
+ "descriptionHTML": "Can be one of all, owner, public, private, member. Default: all
\nWill cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.
"
+ },
+ {
+ "name": "sort",
+ "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "full_name"
+ },
+ "descriptionHTML": "Can be one of created, updated, pushed, full_name.
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be one of asc or desc. Default: asc when using full_name, otherwise desc
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "before",
+ "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/repos')",
+ "html": "await octokit.request('GET /user/repos')\n
"
+ }
+ ],
+ "summary": "List repositories for the authenticated user",
+ "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-repositories-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repositories-for-the-authenticated-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.
\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "418",
+ "httpStatusMessage": "I'm A Teapot",
+ "description": "Response definition missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "post",
+ "requestPath": "/user/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repos \\\n -d '{\"name\":\"name\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /user/repos', {\n name: 'name'\n})",
+ "html": "await octokit.request('POST /user/repos', {\n name: 'name'\n})\n
"
+ }
+ ],
+ "summary": "Create a repository for the authenticated user",
+ "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#create-a-repository-for-the-authenticated-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "name": {
+ "description": "Required. The name of the repository.
",
+ "type": "string",
+ "example": "Team Environment",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ "description": {
+ "description": "A short description of the repository.
",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ "homepage": {
+ "description": "A URL with more information about the repository.
",
+ "type": "string",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ "private": {
+ "description": "Whether the repository is private or public.
",
+ "default": false,
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is private or public.",
+ "childParamsGroups": []
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether issues are enabled.",
+ "childParamsGroups": []
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether projects are enabled.",
+ "childParamsGroups": []
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the wiki is enabled.",
+ "childParamsGroups": []
+ },
+ "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",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ "auto_init": {
+ "description": "Whether the repository is initialized with a minimal README.
",
+ "default": false,
+ "type": "boolean",
+ "name": "auto_init",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is initialized with a minimal README.",
+ "childParamsGroups": []
+ },
+ "gitignore_template": {
+ "description": "The desired language or platform to apply to the .gitignore.
",
+ "example": "Haskell",
+ "type": "string",
+ "name": "gitignore_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The desired language or platform to apply to the .gitignore.",
+ "childParamsGroups": []
+ },
+ "license_template": {
+ "description": "The license keyword of the open source license for this repository.
",
+ "example": "mit",
+ "type": "string",
+ "name": "license_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The license keyword of the open source license for this repository.",
+ "childParamsGroups": []
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow squash merges for pull requests.",
+ "childParamsGroups": []
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow merge commits for pull requests.",
+ "childParamsGroups": []
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow rebase merges for pull requests.",
+ "childParamsGroups": []
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged
",
+ "default": false,
+ "type": "boolean",
+ "example": false,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to delete head branches when pull requests are merged",
+ "childParamsGroups": []
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_downloads",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether downloads are enabled.",
+ "childParamsGroups": []
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.
",
+ "default": false,
+ "type": "boolean",
+ "example": true,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "childParamsGroups": []
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/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://docs.github.com/enterprise-server@2.19/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```",
+ "html": "The is_template and template_repository keys are currently available for developer to preview. See 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 in the Accept header:
\napplication/vnd.github.baptiste-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "create-a-repository-for-the-authenticated-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "descriptionHTML": "Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n\npublic_repo scope or repo scope to create a public repositoryrepo scope to create a private repository
",
+ "bodyParameters": [
+ {
+ "description": "Required. The name of the repository.
",
+ "type": "string",
+ "example": "Team Environment",
+ "name": "name",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The name of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A short description of the repository.
",
+ "type": "string",
+ "name": "description",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A short description of the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "A URL with more information about the repository.
",
+ "type": "string",
+ "name": "homepage",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "A URL with more information about the repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the repository is private or public.
",
+ "default": false,
+ "type": "boolean",
+ "name": "private",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is private or public.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether issues are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_issues",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether issues are enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether projects are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_projects",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether projects are enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the wiki is enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_wiki",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the wiki is enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "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",
+ "name": "team_id",
+ "in": "body",
+ "rawType": "integer",
+ "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether the repository is initialized with a minimal README.
",
+ "default": false,
+ "type": "boolean",
+ "name": "auto_init",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether the repository is initialized with a minimal README.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The desired language or platform to apply to the .gitignore.
",
+ "example": "Haskell",
+ "type": "string",
+ "name": "gitignore_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The desired language or platform to apply to the .gitignore.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "The license keyword of the open source license for this repository.
",
+ "example": "mit",
+ "type": "string",
+ "name": "license_template",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The license keyword of the open source license for this repository.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to allow squash merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_squash_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow squash merges for pull requests.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to allow merge commits for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_merge_commit",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow merge commits for pull requests.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to allow rebase merges for pull requests.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "allow_rebase_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to allow rebase merges for pull requests.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether to delete head branches when pull requests are merged
",
+ "default": false,
+ "type": "boolean",
+ "example": false,
+ "name": "delete_branch_on_merge",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether to delete head branches when pull requests are merged",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether downloads are enabled.
",
+ "default": true,
+ "type": "boolean",
+ "example": true,
+ "name": "has_downloads",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether downloads are enabled.",
+ "childParamsGroups": []
+ },
+ {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.
",
+ "default": false,
+ "type": "boolean",
+ "example": true,
+ "name": "is_template",
+ "in": "body",
+ "rawType": "boolean",
+ "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "childParamsGroups": []
+ }
+ ],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n}\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "400",
+ "httpStatusMessage": "Bad Request",
+ "description": "Bad request"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/repository_invitations",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/repository_invitations')",
+ "html": "await octokit.request('GET /user/repository_invitations')\n
"
+ }
+ ],
+ "summary": "List repository invitations for the authenticated user",
+ "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-repository-invitations-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "list-repository-invitations-for-the-authenticated-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n },\n \"invitee\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"inviter\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"permissions\": \"write\",\n \"created_at\": \"2016-06-13T14:52:50-05:00\",\n \"url\": \"https://api.github.com/user/repository_invitations/1296269\",\n \"html_url\": \"https://github.com/octocat/Hello-World/invitations\",\n \"node_id\": \"MDQ6VXNlcjE=\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "patch",
+ "requestPath": "/user/repository_invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42",
+ "html": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PATCH /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})",
+ "html": "await octokit.request('PATCH /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Accept a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/accept-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#accept-a-repository-invitation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "accept-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/repository_invitations/{invitation_id}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "invitation_id parameter
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/repository_invitations/42
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})",
+ "html": "await octokit.request('DELETE /user/repository_invitations/{invitation_id}', {\n invitation_id: 42\n})\n
"
+ }
+ ],
+ "summary": "Decline a repository invitation",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/decline-invitation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#decline-a-repository-invitation"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "repos",
+ "subcategory": "invitations"
+ },
+ "slug": "decline-a-repository-invitation",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "subcategory": "invitations",
+ "subcategoryLabel": "Invitations",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "409",
+ "httpStatusMessage": "Conflict",
+ "description": "Conflict"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/starred",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/starred')",
+ "html": "await octokit.request('GET /user/starred')\n
"
+ }
+ ],
+ "summary": "List repositories starred by the authenticated user",
+ "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repositories-starred-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "list-repositories-starred-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories the authenticated user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/starred/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('GET /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Check if a repository is starred by the authenticated user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/check-repo-is-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "check-if-a-repository-is-starred-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if this repository is starred by you"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if this repository is not starred by you"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "put",
+ "requestPath": "/user/starred/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('PUT /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Star a repository for the authenticated user",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/star-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#star-a-repository-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "star-a-repository-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/user/starred/{owner}/{repo}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/starred/octocat/hello-world
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /user/starred/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n
"
+ }
+ ],
+ "summary": "Unstar a repository for the authenticated user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/unstar-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#unstar-a-repository-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "unstar-a-repository-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/subscriptions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/subscriptions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/subscriptions')",
+ "html": "await octokit.request('GET /user/subscriptions')\n
"
+ }
+ ],
+ "summary": "List repositories watched by the authenticated user",
+ "description": "Lists repositories the authenticated user is watching.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-watched-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repositories-watched-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "list-repositories-watched-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories the authenticated user is watching.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "401",
+ "httpStatusMessage": "Unauthorized",
+ "description": "Requires authentication"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/user/teams",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/user/teams
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /user/teams')",
+ "html": "await octokit.request('GET /user/teams')\n
"
+ }
+ ],
+ "summary": "List teams for the authenticated user",
+ "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/teams/#list-teams-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "teams",
+ "subcategory": null
+ },
+ "slug": "list-teams-for-the-authenticated-user",
+ "category": "teams",
+ "categoryLabel": "Teams",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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 when authenticating via OAuth.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://api.github.com/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null,\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "since",
+ "description": "A user ID. Only return users with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "A user ID. Only return users with an ID greater than this ID.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users')",
+ "html": "await octokit.request('GET /users')\n
"
+ }
+ ],
+ "summary": "List users",
+ "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/users/#list-users"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "list-users",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get a user",
+ "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@2.19/rest/reference/users#emails)\".",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-by-username",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/users/#get-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "get-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
\nThe email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"twitter_username\": \"monatheoctocat\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\"\n}\n
"
+ },
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response with GitHub plan information",
+ "payload": "{\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"name\": \"monalisa octocat\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"hireable\": false,\n \"bio\": \"There once was...\",\n \"twitter_username\": \"monatheoctocat\",\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2008-01-14T04:33:35Z\",\n \"plan\": {\n \"name\": \"pro\",\n \"space\": 976562499,\n \"collaborators\": 0,\n \"private_repos\": 9999\n }\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/events', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/events', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List events for the authenticated user",
+ "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-events-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-events-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/events/orgs/{org}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/orgs/ORG
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/events/orgs/{org}', {\n username: 'username',\n org: 'org'\n})",
+ "html": "await octokit.request('GET /users/{username}/events/orgs/{org}', {\n username: 'username',\n org: 'org'\n})\n
"
+ }
+ ],
+ "summary": "List organization events for the authenticated user",
+ "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-org-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-organization-events-for-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-organization-events-for-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "This is the user's organization dashboard. You must be authenticated as the user to view this.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/events/public",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/events/public
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/events/public', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/events/public', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List public events for a user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-public-events-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-events-for-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/followers",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/followers
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/followers', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/followers', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List followers of a user",
+ "description": "Lists the people following the specified user.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-followers-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-followers-of-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-followers-of-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people following the specified user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/following",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/following', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/following', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List the people a user follows",
+ "description": "Lists the people who the specified user follows.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-following-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-the-people-a-user-follows"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "list-the-people-a-user-follows",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the people who the specified user follows.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/following/{target_user}",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "target_user",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/following/TARGET_USER
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/following/{target_user}', {\n username: 'username',\n target_user: 'target_user'\n})",
+ "html": "await octokit.request('GET /users/{username}/following/{target_user}', {\n username: 'username',\n target_user: 'target_user'\n})\n
"
+ }
+ ],
+ "summary": "Check if a user follows another user",
+ "description": "",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/check-following-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#check-if-a-user-follows-another-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "followers"
+ },
+ "slug": "check-if-a-user-follows-another-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "followers",
+ "subcategoryLabel": "Followers",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Response if the user follows the target user"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Response if the user does not follow the target user"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/gists",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gists
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/gists', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/gists', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List gists for a user",
+ "description": "Lists public gists for the specified user:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-gists-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "gists",
+ "subcategory": null
+ },
+ "slug": "list-gists-for-a-user",
+ "category": "gists",
+ "categoryLabel": "Gists",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists public gists for the specified user:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n \"id\": \"aa5a315d61ae9438b18d\",\n \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n \"files\": {\n \"hello_world.rb\": {\n \"filename\": \"hello_world.rb\",\n \"type\": \"application/x-ruby\",\n \"language\": \"Ruby\",\n \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n \"size\": 167\n }\n },\n \"public\": true,\n \"created_at\": \"2010-04-14T02:15:15Z\",\n \"updated_at\": \"2011-06-20T11:34:15Z\",\n \"description\": \"Hello World Examples\",\n \"comments\": 0,\n \"user\": null,\n \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"truncated\": false\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/gpg_keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/gpg_keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/gpg_keys', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/gpg_keys', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List GPG keys for a user",
+ "description": "Lists the GPG keys for a user. This information is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-gpg-keys-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "gpg-keys"
+ },
+ "slug": "list-gpg-keys-for-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "gpg-keys",
+ "subcategoryLabel": "Gpg keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 3,\n \"primary_key_id\": 2,\n \"key_id\": \"3262EFF25BA0D270\",\n \"public_key\": \"xsBNBFayYZ...\",\n \"emails\": [\n {\n \"email\": \"mastahyeti@users.noreply.github.com\",\n \"verified\": true\n }\n ],\n \"subkeys\": [\n {\n \"id\": 4,\n \"primary_key_id\": 3,\n \"key_id\": \"4A595D4C72EE49C7\",\n \"public_key\": \"zsBNBFayYZ...\",\n \"emails\": [],\n \"subkeys\": [],\n \"can_sign\": false,\n \"can_encrypt_comms\": true,\n \"can_encrypt_storage\": true,\n \"can_certify\": false,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\"\n }\n ],\n \"can_sign\": true,\n \"can_encrypt_comms\": false,\n \"can_encrypt_storage\": false,\n \"can_certify\": true,\n \"created_at\": \"2016-03-24T11:31:04-06:00\",\n \"expires_at\": \"2016-03-24T11:31:04-07:00\",\n \"raw_key\": \"string\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/hovercard",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ ]
+ },
+ "descriptionHTML": "Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.
"
+ },
+ {
+ "name": "subject_id",
+ "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": "Uses the ID for the subject_type you specified. Required when using subject_type.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/hovercard
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/hovercard', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/hovercard', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Get contextual information for a user",
+ "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-context-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/users/#get-contextual-information-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "users",
+ "subcategory": null
+ },
+ "slug": "get-contextual-information-for-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
\nThe subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:
\ncurl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"contexts\": [\n {\n \"message\": \"Owns this repository\",\n \"octicon\": \"repo\"\n }\n ]\n}\n
"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/installation",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true,
+ "descriptionHTML": "This API is under preview and subject to change.
"
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://api.github.com/users/USERNAME/installation
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/installation', {\n username: 'username',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})",
+ "html": "await octokit.request('GET /users/{username}/installation', {\n username: 'username',\n mediaType: {\n previews: [\n 'machine-man'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "Get a user installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-user-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-a-user-installation-for-the-authenticated-app"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```",
+ "html": "To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests. shell application/vnd.github.machine-man-preview+json
"
+ }
+ ],
+ "category": "apps"
+ },
+ "slug": "get-a-user-installation-for-the-authenticated-app",
+ "category": "apps",
+ "categoryLabel": "Apps",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "{\n \"id\": 1,\n \"account\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"html_url\": \"https://github.com/github\",\n \"followers_url\": \"https://api.github.com/users/github/followers\",\n \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"repository_selection\": \"all\",\n \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n \"repositories_url\": \"https://api.github.com/installation/repositories\",\n \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n \"app_id\": 1,\n \"target_id\": 1,\n \"target_type\": \"Organization\",\n \"permissions\": {\n \"checks\": \"write\",\n \"metadata\": \"read\",\n \"contents\": \"read\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ],\n \"created_at\": \"2018-02-09T20:51:14Z\",\n \"updated_at\": \"2018-02-09T20:51:14Z\",\n \"single_file_name\": \"config.yml\",\n \"app_slug\": \"github-actions\"\n}\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/keys",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/keys
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/keys', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/keys', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List public keys for a user",
+ "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/users#list-public-keys-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "users",
+ "subcategory": "keys"
+ },
+ "slug": "list-public-keys-for-a-user",
+ "category": "users",
+ "categoryLabel": "Users",
+ "subcategory": "keys",
+ "subcategoryLabel": "Keys",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/orgs",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/orgs
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/orgs', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/orgs', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List organizations for a user",
+ "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/orgs/#list-organizations-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": null
+ },
+ "slug": "list-organizations-for-a-user",
+ "category": "orgs",
+ "categoryLabel": "Orgs",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\"\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/projects",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/users/USERNAME/projects
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/projects', {\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})",
+ "html": "await octokit.request('GET /users/{username}/projects', {\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})\n
"
+ }
+ ],
+ "summary": "List user projects",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/projects/#list-user-projects"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```",
+ "html": "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 for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.inertia-preview+json
"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ },
+ "slug": "list-user-projects",
+ "category": "projects",
+ "categoryLabel": "Projects",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"owner_url\": \"https://api.github.com/users/octocat\",\n \"url\": \"https://api.github.com/projects/1002603\",\n \"html_url\": \"https://github.com/users/octocat/projects/1\",\n \"columns_url\": \"https://api.github.com/projects/1002603/columns\",\n \"id\": 1002603,\n \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDM=\",\n \"name\": \"My Projects\",\n \"body\": \"A board to manage my personal projects.\",\n \"number\": 1,\n \"state\": \"open\",\n \"creator\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"created_at\": \"2011-04-10T20:09:31Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n }\n]\n
"
+ },
+ {
+ "httpStatusCode": "415",
+ "httpStatusMessage": "Unsupported Media Type",
+ "description": "Preview header missing"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation failed"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/received_events",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/received_events', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/received_events', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List events received by the authenticated user",
+ "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-events-received-by-the-authenticated-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-events-received-by-the-authenticated-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "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.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/received_events/public",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/received_events/public
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/received_events/public', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/received_events/public', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List public events received by a user",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-public-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-public-events-received-by-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "events"
+ },
+ "slug": "list-public-events-received-by-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "events",
+ "subcategoryLabel": "Events",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": ""
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/repos",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "type",
+ "description": "Can be one of `all`, `owner`, `member`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "all",
+ "owner",
+ "member"
+ ],
+ "default": "owner"
+ },
+ "descriptionHTML": "Can be one of all, owner, member.
"
+ },
+ {
+ "name": "sort",
+ "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "pushed",
+ "full_name"
+ ],
+ "default": "full_name"
+ },
+ "descriptionHTML": "Can be one of created, updated, pushed, full_name.
"
+ },
+ {
+ "name": "direction",
+ "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ },
+ "descriptionHTML": "Can be one of asc or desc. Default: asc when using full_name, otherwise desc
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/repos
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/repos', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/repos', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List repositories for a user",
+ "description": "Lists public repositories for the specified user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/repos/#list-repositories-for-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.19/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```",
+ "html": "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
\nTo access repository visibility during the preview period, you must provide a custom media type in the Accept header:
\napplication/vnd.github.nebula-preview+json
"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ },
+ "slug": "list-repositories-for-a-user",
+ "category": "repos",
+ "categoryLabel": "Repos",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists public repositories for the specified user.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/users/{username}/site_admin",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /users/{username}/site_admin', {\n username: 'username'\n})",
+ "html": "await octokit.request('PUT /users/{username}/site_admin', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Promote a user to be a site administrator",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "enterprise-admin/promote-user-to-be-site-administrator",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#promote-a-user-to-be-a-site-administrator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "promote-a-user-to-be-a-site-administrator",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
"
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/users/{username}/site_admin",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/site_admin
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /users/{username}/site_admin', {\n username: 'username'\n})",
+ "html": "await octokit.request('DELETE /users/{username}/site_admin', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "Demote a site administrator",
+ "description": "You can demote any user account except your own.",
+ "operationId": "enterprise-admin/demote-site-administrator",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#demote-a-site-administrator"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "demote-a-site-administrator",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "You can demote any user account except your own.
"
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/starred",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "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"
+ },
+ "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
"
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ },
+ "descriptionHTML": "One of asc (ascending) or desc (descending).
"
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/starred
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/starred', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/starred', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List repositories starred by a user",
+ "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repositories-starred-by-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "starring"
+ },
+ "slug": "list-repositories-starred-by-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "starring",
+ "subcategoryLabel": "Starring",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header:
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"allow_squash_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/users/{username}/subscriptions",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ },
+ "descriptionHTML": "Results per page (max 100)
"
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ },
+ "descriptionHTML": "Page number of the results to fetch.
"
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/subscriptions
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /users/{username}/subscriptions', {\n username: 'username'\n})",
+ "html": "await octokit.request('GET /users/{username}/subscriptions', {\n username: 'username'\n})\n
"
+ }
+ ],
+ "summary": "List repositories watched by a user",
+ "description": "Lists repositories a user is watching.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-watched-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-repositories-watched-by-a-user"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "activity",
+ "subcategory": "watching"
+ },
+ "slug": "list-repositories-watched-by-a-user",
+ "category": "activity",
+ "categoryLabel": "Activity",
+ "subcategory": "watching",
+ "subcategoryLabel": "Watching",
+ "notes": [],
+ "bodyParameters": [],
+ "descriptionHTML": "Lists repositories a user is watching.
",
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Default response",
+ "payload": "[\n {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"template_repository\": null,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"anonymous_access_enabled\": false,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n }\n]\n
"
+ }
+ ]
+ },
+ {
+ "verb": "put",
+ "requestPath": "/users/{username}/suspended",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'",
+ "html": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('PUT /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})",
+ "html": "await octokit.request('PUT /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})\n
"
+ }
+ ],
+ "summary": "Suspend a user",
+ "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "enterprise-admin/suspend-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#suspend-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "suspend-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
\nYou can suspend any user account except your own.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "delete",
+ "requestPath": "/users/{username}/suspended",
+ "serverUrl": "https://api.github.com",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ }
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/users/USERNAME/suspended \\\n -d '{\"reason\":\"reason\"}'
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('DELETE /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})",
+ "html": "await octokit.request('DELETE /users/{username}/suspended', {\n username: 'username',\n reason: 'reason'\n})\n
"
+ }
+ ],
+ "summary": "Unsuspend a user",
+ "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.",
+ "operationId": "enterprise-admin/unsuspend-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#unsuspend-a-user"
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ },
+ "slug": "unsuspend-a-user",
+ "category": "enterprise-admin",
+ "categoryLabel": "Enterprise admin",
+ "subcategory": "users",
+ "subcategoryLabel": "Users",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "204",
+ "httpStatusMessage": "No Content",
+ "description": "Default Response"
+ }
+ ],
+ "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "description": "The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
",
+ "name": "reason",
+ "in": "body",
+ "rawType": "string",
+ "rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
+ "childParamsGroups": []
+ }
+ ]
+ },
+ {
+ "verb": "get",
+ "requestPath": "/zen",
+ "serverUrl": "https://api.github.com",
+ "parameters": [],
+ "x-codeSamples": [
+ {
+ "lang": "Shell",
+ "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen",
+ "html": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/zen
"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('GET /zen')",
+ "html": "await octokit.request('GET /zen')\n
"
+ }
+ ],
+ "summary": "Get the Zen of GitHub",
+ "description": "Get a random sentence from the Zen of GitHub",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/get-zen",
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "meta"
+ },
+ "slug": "get-the-zen-of-github",
+ "category": "meta",
+ "categoryLabel": "Meta",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "200",
+ "httpStatusMessage": "OK",
+ "description": "Response"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Get a random sentence from the Zen of GitHub
"
+ }
+]
\ No newline at end of file
diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json
new file mode 100644
index 000000000000..88dd0cbfbc3f
--- /dev/null
+++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json
@@ -0,0 +1,247813 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "version": "1.1.4",
+ "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": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname",
+ "default": "HOSTNAME"
+ },
+ "protocol": {
+ "description": "Self-hosted Enterprise Server or Enterprise Cloud protocol",
+ "default": "http"
+ }
+ }
+ }
+ ],
+ "externalDocs": {
+ "description": "GitHub Enterprise Developer Docs",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/"
+ },
+ "paths": {
+ "/": {
+ "get": {
+ "summary": "GitHub API Root",
+ "description": "Get Hypermedia links to resources accessible in GitHub's REST API",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/root",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "current_user_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "current_user_authorizations_html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "authorizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "code_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commit_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "emails_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "emojis_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "feeds_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "hub_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "issue_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "label_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organization_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organization_repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organization_teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "public_gists_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rate_limit_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "current_user_repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "starred_gists_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topic_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_search_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "current_user_url",
+ "current_user_authorizations_html_url",
+ "authorizations_url",
+ "code_search_url",
+ "commit_search_url",
+ "emails_url",
+ "emojis_url",
+ "events_url",
+ "feeds_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "hub_url",
+ "issue_search_url",
+ "issues_url",
+ "keys_url",
+ "label_search_url",
+ "notifications_url",
+ "organization_url",
+ "organization_repositories_url",
+ "organization_teams_url",
+ "public_gists_url",
+ "rate_limit_url",
+ "repository_url",
+ "repository_search_url",
+ "current_user_repositories_url",
+ "starred_url",
+ "starred_gists_url",
+ "user_url",
+ "user_organizations_url",
+ "user_repositories_url",
+ "user_search_url"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "meta"
+ }
+ }
+ },
+ "/admin/hooks": {
+ "get": {
+ "summary": "List global webhooks",
+ "description": "",
+ "operationId": "enterprise-admin/list-global-webhooks",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-global-webhooks"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ },
+ "post": {
+ "summary": "Create a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/create-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.",
+ "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://docs.github.com/enterprise-server@2.18/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": "The [events](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "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",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ }
+ },
+ "/admin/hooks/{hook_id}": {
+ "get": {
+ "summary": "Get a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/get-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a global webhook",
+ "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.",
+ "operationId": "enterprise-admin/update-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "form",
+ "insecure_ssl": "0"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.",
+ "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://docs.github.com/enterprise-server@2.18/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": "The [events](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "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": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/delete-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ }
+ },
+ "/admin/hooks/{hook_id}/pings": {
+ "post": {
+ "summary": "Ping a global webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.18/webhooks/#ping-event) to be sent to the webhook.",
+ "operationId": "enterprise-admin/ping-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#ping-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.18/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ }
+ },
+ "/admin/keys": {
+ "get": {
+ "summary": "List public keys",
+ "description": "",
+ "operationId": "enterprise-admin/list-public-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-public-keys"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "key": {
+ "type": "string"
+ },
+ "user_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "repository_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "user_id": 232,
+ "repository_id": null
+ },
+ {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "user_id": null,
+ "repository_id": 2333,
+ "id": "2",
+ "url": "https://api.github.com/repos/octocat/Hello-World/keys/2"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/keys/{key_ids}": {
+ "delete": {
+ "summary": "Delete a public key",
+ "description": "",
+ "operationId": "enterprise-admin/delete-public-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-a-public-key"
+ },
+ "parameters": [
+ {
+ "name": "key_ids",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/ldap/teams/{team_id}/mapping": {
+ "patch": {
+ "summary": "Update LDAP mapping for a team",
+ "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@2.18/v3/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.",
+ "operationId": "enterprise-admin/update-ldap-mapping-for-team",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com",
+ "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": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."
+ }
+ }
+ },
+ "example": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/ldap/teams/{team_id}/sync": {
+ "post": {
+ "summary": "Sync LDAP mapping for a team",
+ "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
+ "operationId": "enterprise-admin/sync-ldap-mapping-for-team",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "status": "queued"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/ldap/users/{username}/mapping": {
+ "patch": {
+ "summary": "Update LDAP mapping for a user",
+ "description": "",
+ "operationId": "enterprise-admin/update-ldap-mapping-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com",
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."
+ }
+ }
+ },
+ "example": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/ldap/users/{username}/sync": {
+ "post": {
+ "summary": "Sync LDAP mapping for a user",
+ "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
+ "operationId": "enterprise-admin/sync-ldap-mapping-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "status": "queued"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/organizations": {
+ "post": {
+ "summary": "Create an organization",
+ "description": "",
+ "operationId": "enterprise-admin/create-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-an-organization"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The organization's username."
+ },
+ "admin": {
+ "type": "string",
+ "description": "The login of the user who will manage this organization."
+ },
+ "profile_name": {
+ "type": "string",
+ "description": "The organization's display name."
+ }
+ },
+ "required": [
+ "login",
+ "admin"
+ ]
+ },
+ "example": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/admin/organizations/{org}": {
+ "patch": {
+ "summary": "Update an organization name",
+ "description": "",
+ "operationId": "enterprise-admin/update-org-name",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-an-organization-name"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "message": "Job queued to rename organization. It may take a few minutes to complete.",
+ "url": "https:///api/v3/organizations/1"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The organization's new name."
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "the-new-octocats"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/admin/pre-receive-environments": {
+ "get": {
+ "summary": "List pre-receive environments",
+ "description": "",
+ "operationId": "enterprise-admin/list-pre-receive-environments",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-pre-receive-environments"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "name": "Default",
+ "image_url": "githubenterprise://internal",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/1",
+ "default_environment": true,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 14,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
+ "state": "not_started",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ },
+ "post": {
+ "summary": "Create a pre-receive environment",
+ "description": "",
+ "operationId": "enterprise-admin/create-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-a-pre-receive-environment"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The new pre-receive environment's name."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment."
+ }
+ },
+ "required": [
+ "name",
+ "image_url"
+ ]
+ },
+ "example": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-environments/{pre_receive_environment_id}": {
+ "get": {
+ "summary": "Get a pre-receive environment",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ },
+ "patch": {
+ "summary": "Update a pre-receive environment",
+ "description": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.",
+ "operationId": "enterprise-admin/update-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default-response": {
+ "value": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Client Errors",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "client-errors": {
+ "value": {
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "PreReceiveEnvironment",
+ "code": "custom",
+ "message": "Cannot modify or delete the default environment"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This pre-receive environment's new name."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment."
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a pre-receive environment",
+ "description": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_",
+ "operationId": "enterprise-admin/delete-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "422": {
+ "description": "Client Errors",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "client-errors": {
+ "value": {
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "PreReceiveEnvironment",
+ "code": "custom",
+ "message": "Cannot modify or delete the default environment"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": {
+ "post": {
+ "summary": "Start a pre-receive environment download",
+ "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_",
+ "operationId": "enterprise-admin/start-pre-receive-environment-download",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#start-a-pre-receive-environment-download"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default-response": {
+ "value": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest",
+ "state": "not_started",
+ "downloaded_at": null,
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Client Errors",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "client-errors": {
+ "value": {
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "PreReceiveEnvironment",
+ "code": "custom",
+ "message": "Can not start a new download when a download is in progress"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": {
+ "get": {
+ "summary": "Get the download status for a pre-receive environment",
+ "description": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.",
+ "operationId": "enterprise-admin/get-download-status-for-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-hooks": {
+ "get": {
+ "summary": "List pre-receive hooks",
+ "description": "",
+ "operationId": "enterprise-admin/list-pre-receive-hooks",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-pre-receive-hooks"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ },
+ "post": {
+ "summary": "Create a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/create-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-a-pre-receive-hook"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the hook."
+ },
+ "script": {
+ "type": "string",
+ "description": "The script that the hook runs."
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "environment": {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook. default: `disabled`"
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level. default: `false`"
+ }
+ },
+ "required": [
+ "name",
+ "script",
+ "script_repository",
+ "environment"
+ ]
+ },
+ "example": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ }
+ },
+ "/admin/pre-receive-hooks/{pre_receive_hook_id}": {
+ "get": {
+ "summary": "Get a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-a-pre-receive-hook"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/update-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-a-pre-receive-hook"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 1,
+ "name": "Default",
+ "image_url": "githubenterprise://internal",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/1",
+ "default_environment": true,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the hook."
+ },
+ "script": {
+ "type": "string",
+ "description": "The script that the hook runs."
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "environment": {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook."
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level."
+ }
+ }
+ },
+ "example": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/delete-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-a-pre-receive-hook"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ }
+ },
+ "/admin/tokens": {
+ "get": {
+ "summary": "List personal access tokens",
+ "description": "Lists personal access tokens for all users, including admin users.",
+ "operationId": "enterprise-admin/list-personal-access-tokens",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-personal-access-tokens"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 2,
+ "url": "https://enterprise.octocat.com/api/v3/authorizations/2",
+ "app": {
+ "name": "My personal access token",
+ "url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
+ "client_id": "00000000000000000000"
+ },
+ "token": "",
+ "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45",
+ "token_last_eight": "848f9f8a",
+ "note": "My personal access token",
+ "note_url": null,
+ "created_at": "2019-04-24T21:49:02Z",
+ "updated_at": "2019-04-24T21:49:02Z",
+ "scopes": [
+ "admin:business",
+ "admin:gpg_key",
+ "admin:org",
+ "admin:org_hook",
+ "admin:pre_receive_hook",
+ "admin:public_key",
+ "admin:repo_hook",
+ "delete_repo",
+ "gist",
+ "notifications",
+ "repo",
+ "user",
+ "write:discussion"
+ ],
+ "fingerprint": null
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/tokens/{token_id}": {
+ "delete": {
+ "summary": "Delete a personal access token",
+ "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.",
+ "operationId": "enterprise-admin/delete-personal-access-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-a-personal-access-token"
+ },
+ "parameters": [
+ {
+ "name": "token_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/users": {
+ "post": {
+ "summary": "Create a user",
+ "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.",
+ "operationId": "enterprise-admin/create-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-a-user"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The user's username."
+ },
+ "email": {
+ "type": "string",
+ "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://help.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)."
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/users/{username}": {
+ "patch": {
+ "summary": "Update the username for a user",
+ "description": "",
+ "operationId": "enterprise-admin/update-username-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-the-username-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "message": "Job queued to rename user. It may take a few minutes to complete.",
+ "url": "https://api.github.com/user/1"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The user's new username."
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "thenewmonalisa"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Delete a user",
+ "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.",
+ "operationId": "enterprise-admin/delete-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/users/{username}/authorizations": {
+ "post": {
+ "summary": "Create an impersonation OAuth token",
+ "description": "",
+ "operationId": "enterprise-admin/create-impersonation-o-auth-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-an-impersonation-oauth-token"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "type": "array",
+ "description": "A list of [scopes](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Delete an impersonation OAuth token",
+ "description": "",
+ "operationId": "enterprise-admin/delete-impersonation-o-auth-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/app": {
+ "get": {
+ "summary": "Get the authenticated app",
+ "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@2.18/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-the-authenticated-app"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/app-manifests/{code}/conversions": {
+ "post": {
+ "summary": "Create a GitHub App from a manifest",
+ "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-from-manifest",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ },
+ {
+ "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": {
+ "value": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDxOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "client_id": "Iv1.8a61f9b3a7aba766",
+ "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8",
+ "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa",
+ "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "apps",
+ "subcategory": null
+ }
+ }
+ },
+ "/app/installations": {
+ "get": {
+ "summary": "List installations for the authenticated app",
+ "description": "You must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#list-installations-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The permissions the installation has are included under the `permissions` key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}": {
+ "get": {
+ "summary": "Get an installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-an-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ },
+ "delete": {
+ "summary": "Delete an installation for the authenticated app",
+ "description": "Uninstalls a GitHub App on a user, organization, or business account. You must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/delete-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#delete-an-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "gambit",
+ "note": "Uninstalling GitHub Apps and revoking an app's installation token are currently available for developers to preview. To access the new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.gambit-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}/access_tokens": {
+ "post": {
+ "summary": "Create an installation access token for an app",
+ "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-installation-access-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#create-an-installation-access-token-for-an-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "single_file": {
+ "type": "string",
+ "example": "README.md"
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "token": "v1.1f699f1069f60xxx",
+ "expires_at": "2016-07-11T22:14:10Z",
+ "permissions": {
+ "issues": "write",
+ "contents": "read"
+ },
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/applications/grants": {
+ "get": {
+ "summary": "List your grants",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/list-grants",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#list-your-grants"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "scopes",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/applications/grants/{grant_id}": {
+ "get": {
+ "summary": "Get a single grant",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-grant",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#get-a-single-grant"
+ },
+ "parameters": [
+ {
+ "name": "grant_id",
+ "description": "grant_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "scopes",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete a grant",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/delete-grant",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#delete-a-grant"
+ },
+ "parameters": [
+ {
+ "name": "grant_id",
+ "description": "grant_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/applications/{client_id}/grants/{access_token}": {
+ "delete": {
+ "summary": "Revoke a grant for an application",
+ "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "operationId": "oauth-authorizations/revoke-grant-for-application",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#revoke-a-grant-for-an-application"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ }
+ },
+ "/applications/{client_id}/tokens/{access_token}": {
+ "get": {
+ "summary": "Check an authorization",
+ "description": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "operationId": "oauth-authorizations/check-authorization",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#check-an-authorization"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "scopes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "token": {
+ "type": "string"
+ },
+ "token_last_eight": {
+ "type": "string"
+ },
+ "hashed_token": {
+ "type": "string"
+ },
+ "app": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "client_id": {
+ "type": "string"
+ }
+ }
+ },
+ "note": {
+ "type": "string"
+ },
+ "note_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Reset an authorization",
+ "description": "OAuth applications can use this API method to reset a valid OAuth token without end user involvement. Applications must save the \"token\" property in the response, because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "operationId": "oauth-authorizations/reset-authorization",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#reset-an-authorization"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "scopes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "token": {
+ "type": "string"
+ },
+ "token_last_eight": {
+ "type": "string"
+ },
+ "hashed_token": {
+ "type": "string"
+ },
+ "app": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "client_id": {
+ "type": "string"
+ }
+ }
+ },
+ "note": {
+ "type": "string"
+ },
+ "note_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Revoke an authorization for an application",
+ "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`.",
+ "operationId": "oauth-authorizations/revoke-authorization-for-application",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#revoke-an-authorization-for-an-application"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ }
+ },
+ "/apps/{app_slug}": {
+ "get": {
+ "summary": "Get an app",
+ "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-by-slug",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-an-app"
+ },
+ "parameters": [
+ {
+ "name": "app_slug",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/authorizations": {
+ "get": {
+ "summary": "List your authorizations",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/list-authorizations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#list-your-authorizations"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 2,
+ "url": "https://enterprise.octocat.com/api/v3/authorizations/2",
+ "app": {
+ "name": "My personal access token",
+ "url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
+ "client_id": "00000000000000000000"
+ },
+ "token": "",
+ "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45",
+ "token_last_eight": "848f9f8a",
+ "note": "My personal access token",
+ "note_url": null,
+ "created_at": "2019-04-24T21:49:02Z",
+ "updated_at": "2019-04-24T21:49:02Z",
+ "scopes": [
+ "admin:business",
+ "admin:gpg_key",
+ "admin:org",
+ "admin:org_hook",
+ "admin:pre_receive_hook",
+ "admin:public_key",
+ "admin:repo_hook",
+ "delete_repo",
+ "gist",
+ "notifications",
+ "repo",
+ "user",
+ "write:discussion"
+ ],
+ "fingerprint": null
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "post": {
+ "summary": "Create a new authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/create-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.",
+ "type": "string",
+ "example": "Update all gems"
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.",
+ "type": "string"
+ },
+ "client_id": {
+ "description": "The OAuth app client key for which to create the token.",
+ "maxLength": 20,
+ "type": "string"
+ },
+ "client_secret": {
+ "description": "The OAuth app client secret for which to create the token.",
+ "maxLength": 40,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/authorizations/clients/{client_id}": {
+ "put": {
+ "summary": "Get-or-create an authorization for a specific app",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-or-create-authorization-for-app",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "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"
+ },
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "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": ""
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/authorizations/clients/{client_id}/{fingerprint}": {
+ "put": {
+ "summary": "Get-or-create an authorization for a specific app and fingerprint",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response if returning a new token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/authorizations/{authorization_id}": {
+ "get": {
+ "summary": "Get a single authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#get-a-single-authorization"
+ },
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update an existing authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/update-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#update-an-existing-authorization"
+ },
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete an authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/delete-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#delete-an-authorization"
+ },
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "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://docs.github.com/enterprise-server@2.18/v3/codes_of_conduct/#get-all-codes-of-conduct"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ }
+ }
+ },
+ "/codes_of_conduct/{key}": {
+ "get": {
+ "summary": "Get a code of conduct",
+ "description": "",
+ "tags": [
+ "codes-of-conduct"
+ ],
+ "operationId": "codes-of-conduct/get-conduct-code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "key": "contributor_covenant",
+ "name": "Contributor Covenant",
+ "url": "https://api.github.com/codes_of_conduct/contributor_covenant",
+ "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n",
+ "html_url": "http://contributor-covenant.org/version/1/4/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ }
+ }
+ },
+ "/content_references/{content_reference_id}/attachments": {
+ "post": {
+ "summary": "Create a content attachment",
+ "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-content-attachment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment"
+ },
+ "parameters": [
+ {
+ "name": "content_reference_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "The title of the attachment",
+ "example": "Title of the attachment",
+ "type": "string",
+ "maxLength": 1024
+ },
+ "body": {
+ "description": "The body of the attachment",
+ "example": "Body of the attachment",
+ "type": "string",
+ "maxLength": 262144
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 101,
+ "title": "[A-1234] Error found in core/models.py file'",
+ "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "corsair",
+ "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/emojis": {
+ "get": {
+ "summary": "Get emojis",
+ "description": "Lists all the emojis available to use on GitHub Enterprise Server.",
+ "operationId": "emojis/get",
+ "tags": [
+ "emojis"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/emojis/#get-emojis"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "description": "response"
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "emojis",
+ "subcategory": null
+ }
+ }
+ },
+ "/enterprise/settings/license": {
+ "get": {
+ "summary": "Get license information",
+ "description": "",
+ "operationId": "enterprise-admin/get-license-information",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-license-information"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "seats": {
+ "type": "integer"
+ },
+ "seats_used": {
+ "type": "integer"
+ },
+ "seats_available": {
+ "type": "integer"
+ },
+ "kind": {
+ "type": "string"
+ },
+ "days_until_expiration": {
+ "type": "integer"
+ },
+ "expire_at": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "seats": 1400,
+ "seats_used": 1316,
+ "seats_available": 84,
+ "kind": "standard",
+ "days_until_expiration": 365,
+ "expire_at": "2016/02/06 12:41:52 -0600"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "license"
+ }
+ }
+ },
+ "/enterprise/stats/{type}": {
+ "get": {
+ "summary": "Get statistics",
+ "description": "There are a variety of types to choose from:\n\n| Type | Description |\n| ------------ | --------------------------------------------------------------------------------------------------- |\n| `issues` | The number of open and closed issues. |\n| `hooks` | The number of active and inactive hooks. |\n| `milestones` | The number of open and closed milestones. |\n| `orgs` | The number of organizations, teams, team members, and disabled organizations. |\n| `comments` | The number of comments on issues, pull requests, commits, and gists. |\n| `pages` | The number of GitHub Pages sites. |\n| `users` | The number of suspended and admin users. |\n| `gists` | The number of private and public gists. |\n| `pulls` | The number of merged, mergeable, and unmergeable pull requests. |\n| `repos` | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis. |\n| `all` | All of the statistics listed above. |\n\nThese statistics are cached and will be updated approximately every 10 minutes.",
+ "operationId": "enterprise-admin/get-type-stats",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-statistics"
+ },
+ "parameters": [
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repos": {
+ "type": "object",
+ "properties": {
+ "total_repos": {
+ "type": "integer"
+ },
+ "root_repos": {
+ "type": "integer"
+ },
+ "fork_repos": {
+ "type": "integer"
+ },
+ "org_repos": {
+ "type": "integer"
+ },
+ "total_pushes": {
+ "type": "integer"
+ },
+ "total_wikis": {
+ "type": "integer"
+ }
+ }
+ },
+ "hooks": {
+ "type": "object",
+ "properties": {
+ "total_hooks": {
+ "type": "integer"
+ },
+ "active_hooks": {
+ "type": "integer"
+ },
+ "inactive_hooks": {
+ "type": "integer"
+ }
+ }
+ },
+ "pages": {
+ "type": "object",
+ "properties": {
+ "total_pages": {
+ "type": "integer"
+ }
+ }
+ },
+ "orgs": {
+ "type": "object",
+ "properties": {
+ "total_orgs": {
+ "type": "integer"
+ },
+ "disabled_orgs": {
+ "type": "integer"
+ },
+ "total_teams": {
+ "type": "integer"
+ },
+ "total_team_members": {
+ "type": "integer"
+ }
+ }
+ },
+ "users": {
+ "type": "object",
+ "properties": {
+ "total_users": {
+ "type": "integer"
+ },
+ "admin_users": {
+ "type": "integer"
+ },
+ "suspended_users": {
+ "type": "integer"
+ }
+ }
+ },
+ "pulls": {
+ "type": "object",
+ "properties": {
+ "total_pulls": {
+ "type": "integer"
+ },
+ "merged_pulls": {
+ "type": "integer"
+ },
+ "mergeable_pulls": {
+ "type": "integer"
+ },
+ "unmergeable_pulls": {
+ "type": "integer"
+ }
+ }
+ },
+ "issues": {
+ "type": "object",
+ "properties": {
+ "total_issues": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "closed_issues": {
+ "type": "integer"
+ }
+ }
+ },
+ "milestones": {
+ "type": "object",
+ "properties": {
+ "total_milestones": {
+ "type": "integer"
+ },
+ "open_milestones": {
+ "type": "integer"
+ },
+ "closed_milestones": {
+ "type": "integer"
+ }
+ }
+ },
+ "gists": {
+ "type": "object",
+ "properties": {
+ "total_gists": {
+ "type": "integer"
+ },
+ "private_gists": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ }
+ }
+ },
+ "comments": {
+ "type": "object",
+ "properties": {
+ "total_commit_comments": {
+ "type": "integer"
+ },
+ "total_gist_comments": {
+ "type": "integer"
+ },
+ "total_issue_comments": {
+ "type": "integer"
+ },
+ "total_pull_request_comments": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repos": {
+ "total_repos": 212,
+ "root_repos": 194,
+ "fork_repos": 18,
+ "org_repos": 51,
+ "total_pushes": 3082,
+ "total_wikis": 15
+ },
+ "hooks": {
+ "total_hooks": 27,
+ "active_hooks": 23,
+ "inactive_hooks": 4
+ },
+ "pages": {
+ "total_pages": 36
+ },
+ "orgs": {
+ "total_orgs": 33,
+ "disabled_orgs": 0,
+ "total_teams": 60,
+ "total_team_members": 314
+ },
+ "users": {
+ "total_users": 254,
+ "admin_users": 45,
+ "suspended_users": 21
+ },
+ "pulls": {
+ "total_pulls": 86,
+ "merged_pulls": 60,
+ "mergeable_pulls": 21,
+ "unmergeable_pulls": 3
+ },
+ "issues": {
+ "total_issues": 179,
+ "open_issues": 83,
+ "closed_issues": 96
+ },
+ "milestones": {
+ "total_milestones": 7,
+ "open_milestones": 6,
+ "closed_milestones": 1
+ },
+ "gists": {
+ "total_gists": 178,
+ "private_gists": 151,
+ "public_gists": 25
+ },
+ "comments": {
+ "total_commit_comments": 6,
+ "total_gist_comments": 28,
+ "total_issue_comments": 366,
+ "total_pull_request_comments": 30
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "admin-stats"
+ }
+ }
+ },
+ "/events": {
+ "get": {
+ "summary": "List public events",
+ "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-events"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/feeds": {
+ "get": {
+ "summary": "Get feeds",
+ "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@2.18/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 Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-feeds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#get-feeds"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ },
+ "_links": {
+ "type": "array",
+ "required": [
+ "timeline",
+ "user"
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "timeline": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_public": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_actor": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_organization": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_organizations": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "_links",
+ "timeline_url",
+ "user_url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ ],
+ "_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"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/v3/gists/#list-gists-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create a gist",
+ "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.",
+ "operationId": "gists/create",
+ "tags": [
+ "gists"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/public": {
+ "get": {
+ "summary": "List public gists",
+ "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#list-public-gists"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/starred": {
+ "get": {
+ "summary": "List starred gists",
+ "description": "List the authenticated user's starred gists:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#list-starred-gists"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}": {
+ "get": {
+ "summary": "Get a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#get-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update a gist",
+ "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#update-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Delete a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#delete-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}/comments": {
+ "get": {
+ "summary": "List gist comments",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/gists#list-gist-comments"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/gists#create-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/gists#get-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/gists#update-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/gists#delete-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/v3/gists/#list-gist-commits"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}/forks": {
+ "get": {
+ "summary": "List gist forks",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#list-gist-forks"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/dee9c42e4998ce2ea439",
+ "id": "dee9c42e4998ce2ea439",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Fork a gist",
+ "description": "**Note**: This was previously `/gists/:gist_id/fork`.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#fork-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}/star": {
+ "get": {
+ "summary": "Check if a gist is starred",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/check-is-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#check-if-a-gist-is-starred"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "put": {
+ "summary": "Star a gist",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/star",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#star-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Unstar a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/unstar",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#unstar-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}/{sha}": {
+ "get": {
+ "summary": "Get a gist revision",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get-revision",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gists/#get-a-gist-revision"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gitignore/templates": {
+ "get": {
+ "summary": "Get all gitignore templates",
+ "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-for-the-authenticated-user).",
+ "operationId": "gitignore/get-all-templates",
+ "tags": [
+ "gitignore"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "gitignore",
+ "subcategory": null
+ }
+ }
+ },
+ "/gitignore/templates/{name}": {
+ "get": {
+ "summary": "Get a gitignore template",
+ "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) to get the raw contents.",
+ "operationId": "gitignore/get-template",
+ "tags": [
+ "gitignore"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/gitignore/#get-a-gitignore-template"
+ },
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Gitignore Template",
+ "description": "Gitignore Template",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "C"
+ },
+ "source": {
+ "type": "string",
+ "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
+ }
+ },
+ "required": [
+ "name",
+ "source"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "C",
+ "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "gitignore",
+ "subcategory": null
+ }
+ }
+ },
+ "/installation/repositories": {
+ "get": {
+ "summary": "List repositories accessible to the app installation",
+ "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-repos-accessible-to-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#list-repositories-accessible-to-the-app-installation"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "repositories": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "repository_selection": {
+ "type": "string",
+ "example": "selected"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 1,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ },
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```"
+ }
+ ],
+ "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\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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"
+ }
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ }
+ ],
+ "category": "issues"
+ }
+ }
+ },
+ "/licenses": {
+ "get": {
+ "summary": "Get all commonly used licenses",
+ "description": "",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-all-commonly-used",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/licenses/#get-all-commonly-used-licenses"
+ },
+ "parameters": [
+ {
+ "name": "featured",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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=="
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "licenses",
+ "subcategory": null
+ }
+ }
+ },
+ "/licenses/{license}": {
+ "get": {
+ "summary": "Get a license",
+ "description": "",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/licenses/#get-a-license"
+ },
+ "parameters": [
+ {
+ "name": "license",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "License",
+ "description": "License",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "spdx_id": {
+ "type": "string",
+ "example": "MIT",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit",
+ "nullable": true
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://choosealicense.com/licenses/mit/"
+ },
+ "description": {
+ "type": "string",
+ "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty."
+ },
+ "implementation": {
+ "type": "string",
+ "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders."
+ },
+ "permissions": {
+ "type": "array",
+ "example": [
+ "commercial-use",
+ "modifications",
+ "distribution",
+ "sublicense",
+ "private-use"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "conditions": {
+ "type": "array",
+ "example": [
+ "include-copyright"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "limitations": {
+ "type": "array",
+ "example": [
+ "no-liability"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "body": {
+ "type": "string",
+ "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
+ },
+ "featured": {
+ "type": "boolean",
+ "example": true
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id",
+ "html_url",
+ "description",
+ "implementation",
+ "permissions",
+ "conditions",
+ "limitations",
+ "body",
+ "featured"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "http://choosealicense.com/licenses/mit/",
+ "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.",
+ "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.",
+ "permissions": [
+ "commercial-use",
+ "modifications",
+ "distribution",
+ "sublicense",
+ "private-use"
+ ],
+ "conditions": [
+ "include-copyright"
+ ],
+ "limitations": [
+ "no-liability"
+ ],
+ "body": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
+ "featured": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "licenses",
+ "subcategory": null
+ }
+ }
+ },
+ "/markdown": {
+ "post": {
+ "summary": "Render a Markdown document",
+ "description": "",
+ "operationId": "markdown/render",
+ "tags": [
+ "markdown"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "example": "text/html",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "Content-Length": {
+ "example": "279",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "X-CommonMarker-Version": {
+ "example": "0.17.4",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "markdown",
+ "subcategory": null
+ }
+ }
+ },
+ "/markdown/raw": {
+ "post": {
+ "summary": "Render a Markdown document in raw mode",
+ "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.",
+ "operationId": "markdown/render-raw",
+ "tags": [
+ "markdown"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "example": "0.17.4",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "text/html": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "markdown",
+ "subcategory": null
+ }
+ }
+ },
+ "/meta": {
+ "get": {
+ "summary": "Get GitHub Enterprise Server 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://docs.github.com/enterprise-server@2.18/v3/meta/#get-github-meta-information"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Api Overview",
+ "description": "Api Overview",
+ "type": "object",
+ "properties": {
+ "verifiable_password_authentication": {
+ "type": "boolean",
+ "example": true
+ },
+ "github_services_sha": {
+ "type": "string",
+ "example": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
+ },
+ "installed_version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "verifiable_password_authentication"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "verifiable_password_authentication": true,
+ "installed_version": "2.18.0",
+ "github_services_sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "meta",
+ "subcategory": null
+ }
+ }
+ },
+ "/networks/{owner}/{repo}/events": {
+ "get": {
+ "summary": "List public events for a network of repositories",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events-for-repo-network",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-events-for-a-network-of-repositories"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "301": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-notifications-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "all",
+ "description": "If `true`, show notifications marked as read.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "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
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Thread",
+ "description": "Thread",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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 Enterprise Server](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 Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#mark-notifications-as-read"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "last_read_at": {
+ "description": "Describes the last point that notifications were checked.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "read": {
+ "description": "Whether the notification has been read.",
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "205": {
+ "description": "response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#get-a-thread"
+ },
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Thread",
+ "description": "Thread",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#mark-a-thread-as-read"
+ },
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "205": {
+ "description": "response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-thread-subscription-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/notifications/threads/1/subscription",
+ "thread_url": "https://api.github.com/notifications/threads/1"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@2.18/rest/reference/activity#delete-a-thread-subscription) endpoint.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-thread-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#set-a-thread-subscription"
+ },
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/notifications/threads/1/subscription",
+ "thread_url": "https://api.github.com/notifications/threads/1"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-thread-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#delete-a-thread-subscription"
+ },
+ "parameters": [
+ {
+ "name": "thread_id",
+ "description": "thread_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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 Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#list-organizations"
+ },
+ "parameters": [
+ {
+ "name": "since",
+ "description": "An organization ID. Only return organizations with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": null
+ }
+ }
+ },
+ "/orgs/{org}": {
+ "get": {
+ "summary": "Get an organization",
+ "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#get-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ },
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "surtur",
+ "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
+ }
+ ],
+ "category": "orgs",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update an organization",
+ "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#update-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "billing_email": {
+ "type": "string",
+ "description": "Billing email address. This address is not publicized."
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name."
+ },
+ "email": {
+ "type": "string",
+ "description": "The publicly visible email address."
+ },
+ "twitter_username": {
+ "type": "string",
+ "description": "The Twitter username of the company."
+ },
+ "location": {
+ "type": "string",
+ "description": "The location."
+ },
+ "name": {
+ "type": "string",
+ "description": "The shorthand name of the company."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the company."
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "description": "Toggles whether an organization can use organization projects."
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "description": "Toggles whether repositories that belong to the organization can use repository projects."
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.",
+ "enum": [
+ "read",
+ "write",
+ "admin",
+ "none"
+ ],
+ "default": "read"
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.",
+ "default": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
+ "enum": [
+ "all",
+ "private",
+ "none"
+ ]
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. \nDefault: `true`. "
+ },
+ "blog": {
+ "type": "string",
+ "example": "\"http://github.blog\""
+ }
+ }
+ },
+ "example": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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_pages": true,
+ "updated_at": "2014-03-03T18:58:10Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "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"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "surtur",
+ "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
+ }
+ ],
+ "category": "orgs",
+ "subcategory": null
+ }
+ }
+ },
+ "/orgs/{org}/events": {
+ "get": {
+ "summary": "List public organization events",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-org-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-organization-events"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-organization-webhooks"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "post": {
+ "summary": "Create an organization webhook",
+ "description": "Here's how you can create a hook that posts payloads in JSON format:",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#create-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Must be passed as \"web\"."
+ },
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#create-hook-config-params).",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "example": "\"********\""
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "username": {
+ "type": "string",
+ "example": "\"kdaigle\""
+ },
+ "password": {
+ "type": "string",
+ "example": "\"password\""
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/enterprise-server@2.18/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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/orgs/octocat/hooks/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}": {
+ "get": {
+ "summary": "Get an organization webhook",
+ "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#get-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update an organization webhook",
+ "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#update-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#update-hook-config-params).",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "example": "\"********\""
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/enterprise-server@2.18/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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete an organization webhook",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#delete-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/hooks/{hook_id}/pings": {
+ "post": {
+ "summary": "Ping an organization webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.18/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#ping-an-organization-webhook"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/orgs/{org}/installation": {
+ "get": {
+ "summary": "Get an organization installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-org-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-an-organization-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "account": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "repository_selection": "all",
+ "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "created_at": "2018-02-09T20:51:14Z",
+ "updated_at": "2018-02-09T20:51:14Z",
+ "single_file_name": "config.yml",
+ "app_slug": "github-actions"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/orgs/{org}/issues": {
+ "get": {
+ "summary": "List organization issues assigned to the authenticated user",
+ "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ }
+ ],
+ "category": "issues"
+ }
+ }
+ },
+ "/orgs/{org}/members": {
+ "get": {
+ "summary": "List organization members",
+ "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-members",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-organization-members"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#check-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#remove-an-organization-member"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#get-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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"
+ ]
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "can_create_repository": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "can_create_repository"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "role",
+ "organization_url",
+ "url",
+ "organization",
+ "user"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/set-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#set-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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"
+ ]
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "can_create_repository": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "can_create_repository"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "role",
+ "organization_url",
+ "url",
+ "organization",
+ "user"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ }
+ },
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/remove-membership-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#remove-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/outside_collaborators": {
+ "get": {
+ "summary": "List outside collaborators for an organization",
+ "description": "List all users who are outside collaborators of an organization.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-outside-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-outside-collaborators-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "User is getting converted asynchronously"
+ },
+ "204": {
+ "description": "User was converted"
+ },
+ "403": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-user-is-the-last-owner-of-the-organization": {
+ "summary": "Response if user is the last owner of the organization",
+ "value": {
+ "message": "Cannot convert the last owner to an outside collaborator",
+ "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator"
+ }
+ },
+ "response-if-user-is-not-a-member-of-the-organization": {
+ "summary": "Response if user is not a member of the organization",
+ "value": {
+ "message": " is not a member of the organization.",
+ "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#remove-outside-collaborator-from-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "422": {
+ "description": "Response if user is a member of the organization",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-user-is-a-member-of-the-organization": {
+ "value": {
+ "message": "You cannot specify an organization member to remove as an outside collaborator.",
+ "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#remove-outside-collaborator"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "outside-collaborators"
+ }
+ }
+ },
+ "/orgs/{org}/pre-receive-hooks": {
+ "get": {
+ "summary": "List pre-receive hooks for an organization",
+ "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.",
+ "operationId": "enterprise-admin/list-pre-receive-hooks-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
+ "allow_downstream_configuration": true
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ }
+ }
+ },
+ "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": {
+ "get": {
+ "summary": "Get a pre-receive hook for an organization",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ }
+ },
+ "patch": {
+ "summary": "Update pre-receive hook enforcement for an organization",
+ "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`",
+ "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "enabled",
+ "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42",
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enforcement": {
+ "description": "The state of enforcement for the hook on this repository.",
+ "type": "string"
+ },
+ "allow_downstream_configuration": {
+ "description": "Whether repositories can override enforcement.",
+ "type": "boolean"
+ }
+ }
+ },
+ "example": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ }
+ },
+ "delete": {
+ "summary": "Remove pre-receive hook enforcement for an organization",
+ "description": "Removes any overrides for this hook at the org level for this org.",
+ "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "configuration_url": "https://github.example.com/api/v3/admin/pre-receive-hooks/42",
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "org-pre-receive-hooks"
+ }
+ }
+ },
+ "/orgs/{org}/projects": {
+ "get": {
+ "summary": "List organization projects",
+ "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#list-organization-projects"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create an organization project",
+ "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#create-an-organization-project"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ }
+ },
+ "/orgs/{org}/public_members": {
+ "get": {
+ "summary": "List public organization members",
+ "description": "Members of an organization can choose to have their membership publicized or not.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-public-members",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-public-organization-members"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#check-public-organization-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/set-public-membership-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/v3/repos/#list-organization-repositories"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "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": null,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "baptiste",
+ "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create an organization repository",
+ "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#create-an-organization-repository"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "baptiste",
+ "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/orgs/{org}/teams": {
+ "get": {
+ "summary": "List teams",
+ "description": "Lists all teams in an organization that are visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-teams"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create a team",
+ "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#create-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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",
+ "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"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}": {
+ "get": {
+ "summary": "Get a team by name",
+ "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-by-name",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#get-a-team-by-name"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "team_slug parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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",
+ "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"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/projects/columns/cards/{card_id}": {
+ "get": {
+ "summary": "Get a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/get-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/projects#get-a-project-card"
+ },
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#update-a-project-card"
+ },
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "cards"
+ }
+ },
+ "delete": {
+ "summary": "Delete a project card",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/delete-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/projects#delete-a-project-card"
+ },
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "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": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#move-a-project-card"
+ },
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "card_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "description": "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": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#get-a-project-column"
+ },
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#update-a-project-column"
+ },
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ },
+ "delete": {
+ "summary": "Delete a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/delete-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/projects#delete-a-project-column"
+ },
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#list-project-cards"
+ },
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/projects#create-a-project-card"
+ },
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "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"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#move-a-project-column"
+ },
+ "parameters": [
+ {
+ "name": "column_id",
+ "description": "column_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/v3/projects/#get-a-project"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update a project",
+ "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "operationId": "projects/update",
+ "tags": [
+ "projects"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#update-a-project"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Response if the authenticated user does not have access to the project"
+ },
+ "304": {
+ "description": "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": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Delete a project",
+ "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.",
+ "operationId": "projects/delete",
+ "tags": [
+ "projects"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#delete-a-project"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Delete Success"
+ },
+ "304": {
+ "description": "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": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ }
+ },
+ "/projects/{project_id}/collaborators": {
+ "get": {
+ "summary": "List project collaborators",
+ "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/projects#list-project-collaborators"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#add-project-collaborator"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#remove-project-collaborator"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#get-project-permission-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Repository Collaborator Permission",
+ "description": "Repository Collaborator Permission",
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "permission",
+ "user"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/projects#list-project-columns"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": "columns"
+ }
+ },
+ "post": {
+ "summary": "Create a project column",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-column",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/projects#create-a-project-column"
+ },
+ "parameters": [
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "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": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "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.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
+ "tags": [
+ "rate-limit"
+ ],
+ "operationId": "rate-limit/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/rate_limit/#get-rate-limit-status-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Rate Limit Overview",
+ "description": "Rate Limit Overview",
+ "type": "object",
+ "properties": {
+ "resources": {
+ "type": "object",
+ "properties": {
+ "core": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ },
+ "graphql": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ },
+ "search": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ },
+ "source_import": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ },
+ "integration_manifest": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ },
+ "code_scanning_upload": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ }
+ },
+ "required": [
+ "core",
+ "search"
+ ]
+ },
+ "rate": {
+ "title": "Rate Limit",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer"
+ },
+ "remaining": {
+ "type": "integer"
+ },
+ "reset": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit",
+ "remaining",
+ "reset"
+ ]
+ }
+ },
+ "required": [
+ "rate",
+ "resources"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "X-RateLimit-Limit": {
+ "example": "5000",
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "X-RateLimit-Remaining": {
+ "example": "4999",
+ "schema": {
+ "type": "integer"
+ }
+ },
+ "X-RateLimit-Reset": {
+ "example": "1590701888",
+ "schema": {
+ "type": "integer",
+ "format": "timestamp"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "rate-limit",
+ "subcategory": null
+ }
+ }
+ },
+ "/reactions/{reaction_id}": {
+ "delete": {
+ "summary": "Delete a reaction",
+ "description": "OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussion-comments).",
+ "operationId": "reactions/delete",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#delete-a-reaction"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "reaction_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}": {
+ "get": {
+ "summary": "Get a repository",
+ "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#get-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ ]
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "example": true
+ },
+ "allow_merge_commit": {
+ "type": "boolean",
+ "example": true
+ },
+ "subscribers_count": {
+ "type": "integer",
+ "example": 42
+ },
+ "network_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "license": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "parent": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "source": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ },
+ "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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ },
+ "anonymous_access_enabled": false
+ }
+ },
+ "response-with-scarlet-witch-preview-media-type": {
+ "summary": "Response with scarlet-witch-preview media type",
+ "value": {
+ "id": 88760408,
+ "node_id": "MDEwOlJlcG9zaXRvcnk4ODc2MDQwOA==",
+ "name": "cosee",
+ "full_name": "LindseyB/cosee",
+ "disabled": false,
+ "archived": false,
+ "owner": {
+ "login": "LindseyB",
+ "id": 33750,
+ "node_id": "MDQ6VXNlcjMzNzUw",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/33750?v=3",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/LindseyB",
+ "html_url": "https://github.com/LindseyB",
+ "followers_url": "https://api.github.com/users/LindseyB/followers",
+ "following_url": "https://api.github.com/users/LindseyB/following{/other_user}",
+ "gists_url": "https://api.github.com/users/LindseyB/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/LindseyB/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/LindseyB/subscriptions",
+ "organizations_url": "https://api.github.com/users/LindseyB/orgs",
+ "repos_url": "https://api.github.com/users/LindseyB/repos",
+ "events_url": "https://api.github.com/users/LindseyB/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/LindseyB/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "private": false,
+ "html_url": "https://github.com/LindseyB/cosee",
+ "description": null,
+ "fork": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://github.com/licenses/mit"
+ },
+ "url": "https://api.github.com/repos/LindseyB/cosee",
+ "forks_url": "https://api.github.com/repos/LindseyB/cosee/forks",
+ "keys_url": "https://api.github.com/repos/LindseyB/cosee/keys{/key_id}",
+ "collaborators_url": "https://api.github.com/repos/LindseyB/cosee/collaborators{/collaborator}",
+ "teams_url": "https://api.github.com/repos/LindseyB/cosee/teams",
+ "hooks_url": "https://api.github.com/repos/LindseyB/cosee/hooks",
+ "issue_events_url": "https://api.github.com/repos/LindseyB/cosee/issues/events{/number}",
+ "events_url": "https://api.github.com/repos/LindseyB/cosee/events",
+ "assignees_url": "https://api.github.com/repos/LindseyB/cosee/assignees{/user}",
+ "branches_url": "https://api.github.com/repos/LindseyB/cosee/branches{/branch}",
+ "tags_url": "https://api.github.com/repos/LindseyB/cosee/tags",
+ "blobs_url": "https://api.github.com/repos/LindseyB/cosee/git/blobs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/LindseyB/cosee/git/tags{/sha}",
+ "git_refs_url": "https://api.github.com/repos/LindseyB/cosee/git/refs{/sha}",
+ "trees_url": "https://api.github.com/repos/LindseyB/cosee/git/trees{/sha}",
+ "statuses_url": "https://api.github.com/repos/LindseyB/cosee/statuses/{sha}",
+ "languages_url": "https://api.github.com/repos/LindseyB/cosee/languages",
+ "stargazers_url": "https://api.github.com/repos/LindseyB/cosee/stargazers",
+ "contributors_url": "https://api.github.com/repos/LindseyB/cosee/contributors",
+ "subscribers_url": "https://api.github.com/repos/LindseyB/cosee/subscribers",
+ "subscription_url": "https://api.github.com/repos/LindseyB/cosee/subscription",
+ "commits_url": "https://api.github.com/repos/LindseyB/cosee/commits{/sha}",
+ "git_commits_url": "https://api.github.com/repos/LindseyB/cosee/git/commits{/sha}",
+ "comments_url": "https://api.github.com/repos/LindseyB/cosee/comments{/number}",
+ "issue_comment_url": "https://api.github.com/repos/LindseyB/cosee/issues/comments{/number}",
+ "contents_url": "https://api.github.com/repos/LindseyB/cosee/contents/{+path}",
+ "compare_url": "https://api.github.com/repos/LindseyB/cosee/compare/{base}...{head}",
+ "merges_url": "https://api.github.com/repos/LindseyB/cosee/merges",
+ "archive_url": "https://api.github.com/repos/LindseyB/cosee/{archive_format}{/ref}",
+ "downloads_url": "https://api.github.com/repos/LindseyB/cosee/downloads",
+ "issues_url": "https://api.github.com/repos/LindseyB/cosee/issues{/number}",
+ "pulls_url": "https://api.github.com/repos/LindseyB/cosee/pulls{/number}",
+ "milestones_url": "https://api.github.com/repos/LindseyB/cosee/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/LindseyB/cosee/notifications{?since,all,participating}",
+ "labels_url": "https://api.github.com/repos/LindseyB/cosee/labels{/name}",
+ "releases_url": "https://api.github.com/repos/LindseyB/cosee/releases{/id}",
+ "deployments_url": "https://api.github.com/repos/LindseyB/cosee/deployments",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "git_url": "git://github.com/LindseyB/cosee.git",
+ "ssh_url": "git@github.com=>LindseyB/cosee.git",
+ "clone_url": "https://github.com/LindseyB/cosee.git",
+ "svn_url": "https://github.com/LindseyB/cosee",
+ "homepage": null,
+ "size": 1,
+ "stargazers_count": 0,
+ "watchers_count": 0,
+ "language": null,
+ "has_issues": true,
+ "has_projects": true,
+ "has_downloads": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "forks_count": 0,
+ "mirror_url": null,
+ "open_issues_count": 0,
+ "forks": 0,
+ "open_issues": 0,
+ "watchers": 0,
+ "default_branch": "master",
+ "network_count": 0,
+ "subscribers_count": 0
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update a repository",
+ "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#replace-all-repository-topics) endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#update-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ ]
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "example": true
+ },
+ "allow_merge_commit": {
+ "type": "boolean",
+ "example": true
+ },
+ "subscribers_count": {
+ "type": "integer",
+ "example": 42
+ },
+ "network_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "license": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "parent": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "source": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ },
+ "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,
+ "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,
+ "allow_squash_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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ },
+ "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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ },
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "baptiste",
+ "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository",
+ "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#delete-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "message": "Organization members cannot delete repositories.",
+ "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-repository"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/assignees": {
+ "get": {
+ "summary": "List assignees",
+ "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-assignees"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/check-user-can-be-assigned",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#check-if-a-user-can-be-assigned"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "issues",
+ "subcategory": "assignees"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/branches": {
+ "get": {
+ "summary": "List branches",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-branches",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-branches"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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": {
+ "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"
+ ]
+ },
+ "required_pull_request_reviews": {
+ "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": {
+ "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
+ }
+ },
+ "teams": {
+ "description": "The list of teams with review dismissal access.",
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "restrictions": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "restrictions": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "users_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "apps_url",
+ "users",
+ "teams",
+ "apps"
+ ]
+ },
+ "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"
+ ]
+ },
+ "protection_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "name",
+ "commit",
+ "protected"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "name": "master",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "protected": true
+ }
+ ]
+ },
+ "with-protection": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-branch"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Branch With Protection",
+ "description": "Branch With Protection",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "html": {
+ "type": "string"
+ },
+ "self": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "html",
+ "self"
+ ]
+ },
+ "protected": {
+ "type": "boolean"
+ },
+ "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": {
+ "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"
+ ]
+ },
+ "required_pull_request_reviews": {
+ "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": {
+ "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
+ }
+ },
+ "teams": {
+ "description": "The list of teams with review dismissal access.",
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "restrictions": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "restrictions": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "users_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "apps_url",
+ "users",
+ "teams",
+ "apps"
+ ]
+ },
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "master",
+ "commit": {
+ "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==",
+ "commit": {
+ "author": {
+ "name": "The Octocat",
+ "date": "2012-03-06T15:06:50-08:00",
+ "email": "octocat@nowhere.com"
+ },
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "tree": {
+ "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "date": "2012-03-06T15:06:50-08:00",
+ "email": "octocat@nowhere.com"
+ },
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ },
+ "comment_count": 0
+ },
+ "author": {
+ "gravatar_id": "",
+ "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+ "url": "https://api.github.com/users/octocat",
+ "id": 583231,
+ "login": "octocat",
+ "node_id": "MDQ6VXNlcjE=",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "parents": [
+ {
+ "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
+ },
+ {
+ "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303"
+ }
+ ],
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "committer": {
+ "gravatar_id": "",
+ "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+ "url": "https://api.github.com/users/octocat",
+ "id": 583231,
+ "login": "octocat",
+ "node_id": "MDQ6VXNlcjE=",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments"
+ },
+ "_links": {
+ "html": "https://github.com/octocat/Hello-World/tree/master",
+ "self": "https://api.github.com/repos/octocat/Hello-World/branches/master"
+ },
+ "protected": true,
+ "protection": {
+ "enabled": true,
+ "required_status_checks": {
+ "enforcement_level": "non_admins",
+ "contexts": [
+ "ci-test",
+ "linter"
+ ]
+ }
+ },
+ "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-branch-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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"
+ ]
+ },
+ "required_pull_request_reviews": {
+ "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": {
+ "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
+ }
+ },
+ "teams": {
+ "description": "The list of teams with review dismissal access.",
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "restrictions": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "restrictions": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "users_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "apps_url",
+ "users",
+ "teams",
+ "apps"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ },
+ "restrictions": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions",
+ "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams",
+ "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": null
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
+ }
+ ],
+ "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.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-branch-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Protected Branch",
+ "description": "Branch protections protect branches",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "required_status_checks": {
+ "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"
+ ]
+ },
+ "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": {
+ "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
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "restrictions": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "users_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "apps_url",
+ "users",
+ "teams",
+ "apps"
+ ]
+ }
+ },
+ "required": [
+ "url"
+ ]
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-branch-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-admin-branch-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#set-admin-branch-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins",
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-admin-branch-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-admin-branch-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-pull-request-review-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/vnd.github.luke-cage-preview+json": {
+ "schema": {
+ "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": {
+ "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
+ }
+ },
+ "teams": {
+ "description": "The list of teams with review dismissal access.",
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
+ }
+ ],
+ "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.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-pull-request-review-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-pull-request-review-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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
+ }
+ },
+ "teams": {
+ "description": "The list of teams with review dismissal access.",
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "luke-cage",
+ "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-pull-request-review-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-commit-signature-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures",
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "zzzax",
+ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
+ }
+ ],
+ "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.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-commit-signature-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures",
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "zzzax",
+ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
+ }
+ ],
+ "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.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-commit-signature-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-commit-signature-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "zzzax",
+ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-status-checks-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-status-check-protection",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-status-check-potection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#remove-status-check-protection"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-all-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "example": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#add-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "description": "contexts parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "example": [
+ "continuous-integration/travis-ci",
+ "continuous-integration/jenkins"
+ ]
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#set-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "description": "contexts parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "example": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#remove-status-check-contexts"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "type": "array",
+ "description": "contexts parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "contexts"
+ ],
+ "example": {
+ "contexts": [
+ "contexts"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "example": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "restrictions": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "users_url": {
+ "type": "string"
+ },
+ "teams_url": {
+ "type": "string"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string"
+ },
+ "gravatar_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "followers_url": {
+ "type": "string"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "subscriptions_url": {
+ "type": "string"
+ },
+ "organizations_url": {
+ "type": "string"
+ },
+ "repos_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "received_events_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "site_admin": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "teams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "url",
+ "users_url",
+ "teams_url",
+ "apps_url",
+ "users",
+ "teams",
+ "apps"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nDisables the ability to restrict who can push to this branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "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.\n\nLists the teams who have push access to this branch. The list includes child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-teams-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-teams-with-access-to-the-protected-branch"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#add-team-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array",
+ "description": "teams parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#set-team-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array",
+ "description": "teams parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-team-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#remove-team-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "teams": {
+ "type": "array",
+ "description": "teams parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "teams"
+ ],
+ "example": {
+ "teams": [
+ "my-team"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nLists the people who have push access to this branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-users-with-access-to-protected-branch",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-users-with-access-to-the-protected-branch"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#add-user-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "users parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/set-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#set-user-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "users parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/remove-user-access-restrictions",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#remove-user-access-restrictions"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "branch",
+ "description": "branch+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "description": "users parameter",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "users"
+ ],
+ "example": {
+ "users": [
+ "mona"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#create-a-check-run"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the check. For example, \"code-coverage\"."
+ },
+ "head_sha": {
+ "type": "string",
+ "description": "The SHA of the commit."
+ },
+ "details_url": {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used."
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system."
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ],
+ "default": "queued"
+ },
+ "started_at": {
+ "type": "string",
+ "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "conclusion": {
+ "type": "string",
+ "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required"
+ ]
+ },
+ "completed_at": {
+ "type": "string",
+ "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "output": {
+ "type": "object",
+ "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#output-object) description.",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The title of the check run."
+ },
+ "summary": {
+ "type": "string",
+ "description": "The summary of the check run. This parameter supports Markdown."
+ },
+ "text": {
+ "type": "string",
+ "description": "The details of the check run. This parameter supports Markdown."
+ },
+ "annotations": {
+ "type": "array",
+ "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object) description for details about how to use this parameter.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`."
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "The start line of the annotation."
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "The end line of the annotation."
+ },
+ "start_column": {
+ "type": "integer",
+ "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
+ },
+ "end_column": {
+ "type": "integer",
+ "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB."
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters."
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB."
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ }
+ },
+ "images": {
+ "type": "array",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#images-object) description for details.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "The alternative text for the image."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "The full URL of the image."
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description."
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ }
+ }
+ },
+ "required": [
+ "title",
+ "summary"
+ ]
+ },
+ "actions": {
+ "type": "array",
+ "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#check-runs-and-requested-actions).\"",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short explanation of what this action would do. The maximum size is 40 characters."
+ },
+ "identifier": {
+ "type": "string",
+ "description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ }
+ }
+ },
+ "required": [
+ "name",
+ "head_sha"
+ ]
+ },
+ "examples": {
+ "example-of-in-progress-conclusion": {
+ "summary": "Example of in_progress conclusion",
+ "value": {
+ "name": "mighty_readme",
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "status": "in_progress",
+ "external_id": "42",
+ "started_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "",
+ "text": ""
+ }
+ }
+ },
+ "example-of-completed-conclusion": {
+ "summary": "Example of completed conclusion",
+ "value": {
+ "name": "mighty_readme",
+ "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
+ "status": "completed",
+ "started_at": "2017-11-30T19:39:10Z",
+ "conclusion": "success",
+ "completed_at": "2017-11-30T19:49:10Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notices.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations": [
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'banaas'.",
+ "raw_details": "Do you mean 'bananas' or 'banana'?",
+ "start_line": 2,
+ "end_line": 2
+ },
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'aples'",
+ "raw_details": "Do you mean 'apples' or 'Naples'",
+ "start_line": 4,
+ "end_line": 4
+ }
+ ],
+ "images": [
+ {
+ "alt": "Super bananas",
+ "image_url": "http://example.com/images/42"
+ }
+ ]
+ },
+ "actions": [
+ {
+ "label": "Fix",
+ "identifier": "fix_errors",
+ "description": "Allow us to fix these errors for you"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "pull_requests": {
+ "items": {
+ "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"
+ ]
+ }
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "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": null,
+ "started_at": "2018-05-04T01:14:52Z",
+ "completed_at": null,
+ "output": {
+ "title": "Mighty Readme Report",
+ "summary": "",
+ "text": "",
+ "annotations_count": 1,
+ "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations"
+ },
+ "name": "mighty_readme",
+ "check_suite": {
+ "id": 5
+ },
+ "app": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDExOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "pull_requests": [
+ {
+ "url": "https://api.github.com/repos/github/hello-world/pulls/1",
+ "id": 1934,
+ "number": 3956,
+ "head": {
+ "ref": "say-hello",
+ "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ },
+ "base": {
+ "ref": "master",
+ "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f",
+ "repo": {
+ "id": 526,
+ "url": "https://api.github.com/repos/github/hello-world",
+ "name": "hello-world"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#get-a-check-run"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "pull_requests": {
+ "items": {
+ "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"
+ ]
+ }
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the check. For example, \"code-coverage\"."
+ },
+ "details_url": {
+ "type": "string",
+ "description": "The URL of the integrator's site that has the full details of the check."
+ },
+ "external_id": {
+ "type": "string",
+ "description": "A reference for the run on the integrator's system."
+ },
+ "started_at": {
+ "type": "string",
+ "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "status": {
+ "type": "string",
+ "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
+ "enum": [
+ "queued",
+ "in_progress",
+ "completed"
+ ]
+ },
+ "conclusion": {
+ "type": "string",
+ "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.",
+ "enum": [
+ "success",
+ "failure",
+ "neutral",
+ "cancelled",
+ "skipped",
+ "timed_out",
+ "action_required"
+ ]
+ },
+ "completed_at": {
+ "type": "string",
+ "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ },
+ "output": {
+ "type": "object",
+ "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#output-object-1) description.",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "**Required**."
+ },
+ "summary": {
+ "type": "string",
+ "description": "Can contain Markdown."
+ },
+ "text": {
+ "type": "string",
+ "description": "Can contain Markdown."
+ },
+ "annotations": {
+ "type": "array",
+ "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`."
+ },
+ "start_line": {
+ "type": "integer",
+ "description": "The start line of the annotation."
+ },
+ "end_line": {
+ "type": "integer",
+ "description": "The end line of the annotation."
+ },
+ "start_column": {
+ "type": "integer",
+ "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
+ },
+ "end_column": {
+ "type": "integer",
+ "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values."
+ },
+ "annotation_level": {
+ "type": "string",
+ "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
+ "enum": [
+ "notice",
+ "warning",
+ "failure"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB."
+ },
+ "title": {
+ "type": "string",
+ "description": "The title that represents the annotation. The maximum size is 255 characters."
+ },
+ "raw_details": {
+ "type": "string",
+ "description": "Details about this annotation. The maximum size is 64 KB."
+ }
+ },
+ "required": [
+ "path",
+ "start_line",
+ "end_line",
+ "annotation_level",
+ "message"
+ ]
+ }
+ },
+ "images": {
+ "type": "array",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#annotations-object-1) description for details.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "alt": {
+ "type": "string",
+ "description": "The alternative text for the image."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "The full URL of the image."
+ },
+ "caption": {
+ "type": "string",
+ "description": "A short image description."
+ }
+ },
+ "required": [
+ "alt",
+ "image_url"
+ ]
+ }
+ }
+ },
+ "required": [
+ "summary"
+ ]
+ },
+ "actions": {
+ "type": "array",
+ "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#check-runs-and-requested-actions).\"",
+ "items": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short explanation of what this action would do. The maximum size is 40 characters."
+ },
+ "identifier": {
+ "type": "string",
+ "description": "A reference for the action on the integrator's system. The maximum size is 20 characters."
+ }
+ },
+ "required": [
+ "label",
+ "description",
+ "identifier"
+ ]
+ }
+ }
+ }
+ },
+ "example": {
+ "name": "mighty_readme",
+ "started_at": "2018-05-04T01:14:52Z",
+ "status": "completed",
+ "conclusion": "success",
+ "completed_at": "2018-05-04T01:14:52Z",
+ "output": {
+ "title": "Mighty Readme report",
+ "summary": "There are 0 failures, 2 warnings, and 1 notices.",
+ "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
+ "annotations": [
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'banaas'.",
+ "raw_details": "Do you mean 'bananas' or 'banana'?",
+ "start_line": 2,
+ "end_line": 2
+ },
+ {
+ "path": "README.md",
+ "annotation_level": "warning",
+ "title": "Spell Checker",
+ "message": "Check your spelling for 'aples'",
+ "raw_details": "Do you mean 'apples' or 'Naples'",
+ "start_line": 4,
+ "end_line": 4
+ }
+ ],
+ "images": [
+ {
+ "alt": "Super bananas",
+ "image_url": "http://example.com/images/42"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "pull_requests": {
+ "items": {
+ "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"
+ ]
+ }
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/checks#list-check-run-annotations"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/create-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#create-a-check-suite"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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"
+ ]
+ },
+ "nullable": true
+ },
+ "app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "head_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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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
+ },
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ },
+ "head_commit": {
+ "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "timestamp": "2016-10-10T00:00:00Z",
+ "author": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ }
+ },
+ "latest_check_runs_count": 1,
+ "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/set-suites-preferences",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#update-repository-preferences-for-check-suites"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "auto_trigger_checks": {
+ "type": "array",
+ "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@2.18/rest/reference/checks#auto_trigger_checks-object) description for details.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "app_id": {
+ "type": "integer",
+ "description": "The `id` of the GitHub App."
+ },
+ "setting": {
+ "type": "boolean",
+ "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
+ "default": true
+ }
+ },
+ "required": [
+ "app_id",
+ "setting"
+ ]
+ }
+ }
+ }
+ },
+ "example": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/get-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#get-a-check-suite"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_suite_id",
+ "description": "check_suite_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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"
+ ]
+ },
+ "nullable": true
+ },
+ "app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "head_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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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
+ },
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ },
+ "head_commit": {
+ "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+ "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
+ "timestamp": "2016-10-10T00:00:00Z",
+ "author": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ },
+ "committer": {
+ "name": "The Octocat",
+ "email": "octocat@nowhere.com"
+ }
+ },
+ "latest_check_runs_count": 1,
+ "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-for-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#list-check-runs-in-a-check-suite"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_suite_id",
+ "description": "check_suite_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "check_runs": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "pull_requests": {
+ "items": {
+ "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"
+ ]
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-suite",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#rerequest-a-check-suite"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_suite_id",
+ "description": "check_suite_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "category": "checks",
+ "subcategory": "suites"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/collaborators": {
+ "get": {
+ "summary": "List repository collaborators",
+ "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-collaborators",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-collaborators"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nTeam members will include the members of child teams.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/check-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#check-if-a-user-is-a-repository-collaborator"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/add-collaborator",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#add-a-repository-collaborator"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "invitee": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "inviter": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response when person is already a collaborator"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#remove-a-repository-collaborator"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-repository-permissions-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response if user has admin permissions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Repository Collaborator Permission",
+ "description": "Repository Collaborator Permission",
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "permission",
+ "user"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/).\n\nComments are ordered by ascending ID.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commit-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commit-comments-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a commit comment",
+ "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the commit comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/commits": {
+ "get": {
+ "summary": "List commits",
+ "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "support@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "support@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-branches-for-head-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-branches-for-head-commit"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "name": "branch_5",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "protected": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "groot",
+ "note": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.groot-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commit-comments"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "repos",
+ "subcategory": "comments"
+ }
+ },
+ "post": {
+ "summary": "Create a commit comment",
+ "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-commit-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "id",
+ "node_id",
+ "user",
+ "position",
+ "line",
+ "path",
+ "commit_id",
+ "body",
+ "author_association",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests) endpoint.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pull-requests-associated-with-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-pull-requests-associated-with-a-commit"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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",
+ "parent": null
+ }
+ ],
+ "head": {
+ "label": "octocat:new-topic",
+ "ref": "new-topic",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ },
+ "base": {
+ "label": "octocat:master",
+ "ref": "master",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ },
+ "_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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "groot",
+ "note": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.groot-preview+json\n```"
+ }
+ ],
+ "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.\n\n**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nYou can pass the appropriate [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-commit"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ],
+ "stats": {
+ "additions": 104,
+ "deletions": 4,
+ "total": 108
+ },
+ "files": [
+ {
+ "filename": "file1.txt",
+ "additions": 10,
+ "deletions": 2,
+ "changes": 12,
+ "status": "modified",
+ "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt",
+ "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt",
+ "patch": "@@ -29,7 +29,7 @@\n....."
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#list-check-runs-for-a-git-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "check_runs": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "pull_requests": {
+ "items": {
+ "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"
+ ]
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/list-suites-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/checks#list-check-suites-for-a-git-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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
+ },
+ {
+ "name": "check_name",
+ "description": "Returns check runs with the specified `name`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "check_suites": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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"
+ ]
+ },
+ "nullable": true
+ },
+ "app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "head_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"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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"
+ ]
+ },
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "antiope",
+ "note": "The Checks 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/2018-05-07-new-checks-api-public-beta/) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.antiope-preview+json\n```"
+ }
+ ],
+ "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.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-combined-status-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-combined-status-for-a-specific-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Combined Commit Status",
+ "description": "Combined Commit Status",
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string"
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "sha": {
+ "type": "string"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "commit_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "state",
+ "sha",
+ "total_count",
+ "statuses",
+ "repository",
+ "commit_url",
+ "url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-commit-statuses-for-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commit-statuses-for-a-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "301": {
+ "description": "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://docs.github.com/enterprise-server@2.18/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "key": "contributor_covenant",
+ "name": "Contributor Covenant",
+ "url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md",
+ "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include=>\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include=>\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\nto any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n",
+ "html_url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/compare/{base}...{head}": {
+ "get": {
+ "summary": "Compare two commits",
+ "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/compare-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#compare-two-commits"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "merge_base_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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "files": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "permalink_url",
+ "diff_url",
+ "patch_url",
+ "base_commit",
+ "merge_base_commit",
+ "status",
+ "ahead_by",
+ "behind_by",
+ "total_commits",
+ "commits",
+ "files"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic",
+ "html_url": "https://github.com/octocat/Hello-World/compare/master...topic",
+ "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17",
+ "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch",
+ "base_commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ },
+ "merge_base_commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ },
+ "status": "behind",
+ "ahead_by": 1,
+ "behind_by": 2,
+ "total_commits": 1,
+ "commits": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ }
+ ],
+ "files": [
+ {
+ "sha": "bbcd538c8e72b8c175046e27cc8f907076331401",
+ "filename": "file1.txt",
+ "status": "added",
+ "additions": 103,
+ "deletions": 21,
+ "changes": 124,
+ "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+ "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@2.18/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-content",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-repository-content"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "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"
+ ]
+ }
+ },
+ {
+ "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"
+ ]
+ },
+ {
+ "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"
+ ]
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ }
+ },
+ "response-if-content-is-a-directory": {
+ "summary": "Response if content is a directory",
+ "value": [
+ {
+ "type": "file",
+ "size": 625,
+ "name": "octokit.rb",
+ "path": "lib/octokit.rb",
+ "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb",
+ "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb",
+ "_links": {
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb",
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b",
+ "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb"
+ }
+ },
+ {
+ "type": "dir",
+ "size": 0,
+ "name": "octokit",
+ "path": "lib/octokit",
+ "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit",
+ "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit",
+ "download_url": null,
+ "_links": {
+ "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit",
+ "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
+ "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit"
+ }
+ }
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "response-if-content-is-a-submodule": {
+ "summary": "Response if content is a submodule",
+ "value": {
+ "type": "submodule",
+ "submodule_git_url": "git://github.com/jquery/qunit.git",
+ "size": 0,
+ "name": "qunit",
+ "path": "test/qunit",
+ "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master",
+ "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "download_url": null,
+ "_links": {
+ "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9",
+ "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master",
+ "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "302": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-or-update-file-contents"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "example-for-updating-a-file": {
+ "value": {
+ "content": {
+ "name": "hello.txt",
+ "path": "notes/hello.txt",
+ "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd",
+ "size": 9,
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt",
+ "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd",
+ "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt",
+ "type": "file",
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd",
+ "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
+ }
+ },
+ "commit": {
+ "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
+ "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f",
+ "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6",
+ "sha": "da5a433788da5c255edad7979b328b67d79f53f6"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "example-for-creating-a-file": {
+ "value": {
+ "content": {
+ "name": "hello.txt",
+ "path": "notes/hello.txt",
+ "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+ "size": 9,
+ "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt",
+ "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+ "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt",
+ "type": "file",
+ "_links": {
+ "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+ "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+ "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
+ }
+ },
+ "commit": {
+ "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+ "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "contents"
+ }
+ },
+ "delete": {
+ "summary": "Delete a file",
+ "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-file",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-file"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": null,
+ "commit": {
+ "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+ "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "author": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "committer": {
+ "date": "2014-11-07T22:01:45Z",
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "message": "my commit message",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+ "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+ "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+ }
+ ],
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-contributors",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-contributors"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "anon",
+ "description": "Set to `1` or `true` to include anonymous contributors in results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response if repository contains content",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "204": {
+ "description": "Response if repository is empty"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/deployments": {
+ "get": {
+ "summary": "List deployments",
+ "description": "Simple filtering of deployments is available via query parameters:",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-deployments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-deployments"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ },
+ "transient_environment": {
+ "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "production_environment": {
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "sha",
+ "ref",
+ "task",
+ "environment",
+ "creator",
+ "payload",
+ "description",
+ "statuses_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ }
+ },
+ "post": {
+ "summary": "Create a deployment",
+ "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deployment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ref": {
+ "type": "string",
+ "description": "The ref to deploy. This can be a branch, tag, or SHA."
+ },
+ "task": {
+ "type": "string",
+ "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
+ "default": "deploy"
+ },
+ "auto_merge": {
+ "type": "boolean",
+ "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
+ "default": true
+ },
+ "required_contexts": {
+ "type": "array",
+ "description": "The [status](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "payload": {
+ "type": "string",
+ "description": "JSON payload with extra information about the deployment.",
+ "default": ""
+ },
+ "environment": {
+ "type": "string",
+ "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
+ "default": "production"
+ },
+ "description": {
+ "type": "string",
+ "description": "Short description of the deployment.",
+ "default": "",
+ "nullable": true
+ },
+ "transient_environment": {
+ "type": "boolean",
+ "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "default": false
+ },
+ "production_environment": {
+ "type": "boolean",
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type."
+ },
+ "created_at": {
+ "type": "string",
+ "example": "\"1776-07-04T00:00:00.000-07:52\""
+ }
+ },
+ "required": [
+ "ref"
+ ]
+ },
+ "examples": {
+ "simple-example": {
+ "summary": "Simple example",
+ "value": {
+ "ref": "topic-branch",
+ "payload": "{ \"deploy\": \"migrate\" }",
+ "description": "Deploy request from hubot"
+ }
+ },
+ "advanced-example": {
+ "summary": "Advanced example",
+ "value": {
+ "ref": "topic-branch",
+ "auto_merge": false,
+ "payload": "{ \"deploy\": \"migrate\" }",
+ "description": "Deploy request from hubot",
+ "required_contexts": [
+ "ci/janky",
+ "security/brakeman"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ },
+ "transient_environment": {
+ "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "production_environment": {
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "sha",
+ "ref",
+ "task",
+ "environment",
+ "creator",
+ "payload",
+ "description",
+ "statuses_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ },
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Merged branch response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "merged-branch-response": {
+ "value": {
+ "message": "Auto-merged master into topic-branch on deployment."
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string",
+ "example": "\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deployment\""
+ }
+ }
+ },
+ "examples": {
+ "merge-conflict-response": {
+ "summary": "Merge conflict response",
+ "value": {
+ "message": "Conflict merging master into topic-branch"
+ }
+ },
+ "failed-commit-status-checks": {
+ "summary": "Failed commit status checks",
+ "value": {
+ "message": "Conflict: Commit status checks failed for topic-branch."
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-deployment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2012-07-20T01:19:13Z"
+ },
+ "statuses_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/example"
+ },
+ "transient_environment": {
+ "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "production_environment": {
+ "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.",
+ "example": true,
+ "type": "boolean"
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "sha",
+ "ref",
+ "task",
+ "environment",
+ "creator",
+ "payload",
+ "description",
+ "statuses_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ },
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-deployment-statuses"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "state",
+ "creator",
+ "description",
+ "deployment_url",
+ "target_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ }
+ },
+ "post": {
+ "summary": "Create a deployment status",
+ "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-deployment-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deployment-status"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
+ "enum": [
+ "error",
+ "failure",
+ "inactive",
+ "in_progress",
+ "queued",
+ "pending",
+ "success"
+ ]
+ },
+ "target_url": {
+ "type": "string",
+ "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.",
+ "default": ""
+ },
+ "log_url": {
+ "type": "string",
+ "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "default": ""
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the status. The maximum description length is 140 characters.",
+ "default": ""
+ },
+ "environment": {
+ "type": "string",
+ "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type.",
+ "enum": [
+ "production",
+ "staging",
+ "qa"
+ ]
+ },
+ "environment_url": {
+ "type": "string",
+ "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type.",
+ "default": ""
+ },
+ "auto_inactive": {
+ "type": "boolean",
+ "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@2.18/rest/overview/api-previews#enhanced-deployments) custom media type."
+ }
+ },
+ "required": [
+ "state"
+ ]
+ },
+ "example": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "state",
+ "creator",
+ "description",
+ "deployment_url",
+ "target_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-deployment-status"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "deployment_id",
+ "description": "deployment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "status_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "state",
+ "creator",
+ "description",
+ "deployment_url",
+ "target_url",
+ "repository_url",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ },
+ {
+ "required": false,
+ "name": "flash",
+ "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "ant-man",
+ "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "deployments"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/events": {
+ "get": {
+ "summary": "List repository events",
+ "description": "",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repo-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repository-events"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-forks"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": true,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "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": null,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "forks"
+ }
+ },
+ "post": {
+ "summary": "Create a fork",
+ "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://github.com/contact) or [GitHub Enterprise Server Premium Support](https://premium.githubsupport.com).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-fork",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-fork"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-blob"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Short Blob",
+ "description": "Short Blob",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\n_Note_: This API supports blobs up to 100 megabytes in size.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-blob",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-blob"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "file_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Q29udGVudCBvZiB0aGUgYmxvYg==",
+ "encoding": "base64",
+ "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
+ "size": 19,
+ "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg=="
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-commit"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The commit message"
+ },
+ "tree": {
+ "type": "string",
+ "description": "The SHA of the tree object this commit points to"
+ },
+ "parents": {
+ "type": "array",
+ "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "author": {
+ "type": "object",
+ "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit"
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ }
+ },
+ "committer": {
+ "type": "object",
+ "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the author (or committer) of the commit"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email of the author (or committer) of the commit"
+ },
+ "date": {
+ "type": "string",
+ "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
+ }
+ }
+ },
+ "signature": {
+ "type": "string",
+ "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits."
+ }
+ },
+ "required": [
+ "message",
+ "tree"
+ ]
+ },
+ "example": {
+ "message": "my commit message",
+ "author": {
+ "name": "Mona Octocat",
+ "email": "octocat@github.com",
+ "date": "2008-07-09T16:13:30+12:00"
+ },
+ "parents": [
+ "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
+ ],
+ "tree": "827efc6d56897b048c772eb4087f854f46256132",
+ "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-commit",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-commit"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "commit_sha",
+ "description": "commit_sha+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "git",
+ "subcategory": "commits"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/refs": {
+ "post": {
+ "summary": "Create a reference",
+ "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-ref",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "git",
+ "subcategory": "refs"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/git/refs/{namespace}": {
+ "get": {
+ "summary": "Get all references",
+ "description": "Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-single-pull-request) to trigger a merge commit creation. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.18/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\n```\nGET /repos/octocat/Hello-World/git/refs\n```\n\nYou can also request a sub-namespace. For example, to get all the tag references, you can call:\n\n```\nGET /repos/octocat/Hello-World/git/refs/tags\n```",
+ "operationId": "git/get-all-refs",
+ "tags": [
+ "git"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#list-references"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/git#update-a-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/git#delete-a-reference"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ref",
+ "description": "ref+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-tag-object"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "node_id",
+ "tagger",
+ "object",
+ "tag",
+ "message"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
+ "tag": "v0.0.1",
+ "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "message": "initial version",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2014-11-07T22:01:45Z"
+ },
+ "object": {
+ "type": "commit",
+ "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
+ },
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tag",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-tag"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "tag_sha",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "sha",
+ "url",
+ "node_id",
+ "tagger",
+ "object",
+ "tag",
+ "message"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
+ "tag": "v0.0.1",
+ "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
+ "message": "initial version",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2014-11-07T22:01:45Z"
+ },
+ "object": {
+ "type": "commit",
+ "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
+ },
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@2.18/rest/reference/git#update-a-reference).\"",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/create-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#create-a-tree"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
+ "tags": [
+ "git"
+ ],
+ "operationId": "git/get-tree",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/git#get-a-tree"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ },
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-webhooks"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Webhook",
+ "description": "Webhooks for repositories.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the webhook.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of a valid service, use 'web' for a webhook.",
+ "example": "web",
+ "type": "string"
+ },
+ "active": {
+ "description": "Determines whether the hook is actually triggered on pushes.",
+ "type": "boolean",
+ "example": true
+ },
+ "events": {
+ "description": "Determines what events the hook is triggered for. Default: ['push'].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "example": "\"foo@bar.com\""
+ },
+ "password": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "room": {
+ "type": "string",
+ "example": "\"roomer\""
+ },
+ "subdomain": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "ping_url",
+ "created_at",
+ "updated_at",
+ "last_response",
+ "test_url"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "type": "Repository",
+ "id": 12345678,
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "url": "https://example.com/webhook"
+ },
+ "updated_at": "2019-06-03T00:57:16Z",
+ "created_at": "2019-06-03T00:57:16Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
+ "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "post": {
+ "summary": "Create a repository webhook",
+ "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`."
+ },
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-hook-config-params).",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "example": "\"********\""
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "token": {
+ "type": "string",
+ "example": "\"abc\""
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\""
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/enterprise-server@2.18/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": {
+ "title": "Webhook",
+ "description": "Webhooks for repositories.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the webhook.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of a valid service, use 'web' for a webhook.",
+ "example": "web",
+ "type": "string"
+ },
+ "active": {
+ "description": "Determines whether the hook is actually triggered on pushes.",
+ "type": "boolean",
+ "example": true
+ },
+ "events": {
+ "description": "Determines what events the hook is triggered for. Default: ['push'].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "example": "\"foo@bar.com\""
+ },
+ "password": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "room": {
+ "type": "string",
+ "example": "\"roomer\""
+ },
+ "subdomain": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "ping_url",
+ "created_at",
+ "updated_at",
+ "last_response",
+ "test_url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Repository",
+ "id": 12345678,
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "url": "https://example.com/webhook"
+ },
+ "updated_at": "2019-06-03T00:57:16Z",
+ "created_at": "2019-06-03T00:57:16Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
+ "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}": {
+ "get": {
+ "summary": "Get a repository webhook",
+ "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Webhook",
+ "description": "Webhooks for repositories.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the webhook.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of a valid service, use 'web' for a webhook.",
+ "example": "web",
+ "type": "string"
+ },
+ "active": {
+ "description": "Determines whether the hook is actually triggered on pushes.",
+ "type": "boolean",
+ "example": true
+ },
+ "events": {
+ "description": "Determines what events the hook is triggered for. Default: ['push'].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "example": "\"foo@bar.com\""
+ },
+ "password": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "room": {
+ "type": "string",
+ "example": "\"roomer\""
+ },
+ "subdomain": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "ping_url",
+ "created_at",
+ "updated_at",
+ "last_response",
+ "test_url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Repository",
+ "id": 12345678,
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "url": "https://example.com/webhook"
+ },
+ "updated_at": "2019-06-03T00:57:16Z",
+ "created_at": "2019-06-03T00:57:16Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
+ "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a repository webhook",
+ "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-hook-config-params).",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "example": "\"********\""
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "address": {
+ "type": "string",
+ "example": "\"bar@example.com\""
+ },
+ "room": {
+ "type": "string",
+ "example": "\"The Serious Room\""
+ }
+ },
+ "required": [
+ "url"
+ ]
+ },
+ "events": {
+ "type": "array",
+ "description": "Determines what [events](https://docs.github.com/enterprise-server@2.18/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": {
+ "title": "Webhook",
+ "description": "Webhooks for repositories.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the webhook.",
+ "example": 42,
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of a valid service, use 'web' for a webhook.",
+ "example": "web",
+ "type": "string"
+ },
+ "active": {
+ "description": "Determines whether the hook is actually triggered on pushes.",
+ "type": "boolean",
+ "example": true
+ },
+ "events": {
+ "description": "Determines what events the hook is triggered for. Default: ['push'].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "push",
+ "pull_request"
+ ]
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "example": "\"foo@bar.com\""
+ },
+ "password": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "room": {
+ "type": "string",
+ "example": "\"roomer\""
+ },
+ "subdomain": {
+ "type": "string",
+ "example": "\"foo\""
+ },
+ "url": {
+ "type": "string",
+ "description": "The URL to which the payloads will be delivered.",
+ "example": "https://example.com/webhook",
+ "format": "uri"
+ },
+ "insecure_ssl": {
+ "type": "string",
+ "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
+ "example": "\"0\""
+ },
+ "content_type": {
+ "type": "string",
+ "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
+ "example": "\"json\""
+ },
+ "digest": {
+ "type": "string",
+ "example": "\"sha256\""
+ },
+ "secret": {
+ "type": "string",
+ "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#delivery-headers).",
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "url",
+ "type",
+ "name",
+ "active",
+ "events",
+ "config",
+ "ping_url",
+ "created_at",
+ "updated_at",
+ "last_response",
+ "test_url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Repository",
+ "id": 12345678,
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "url": "https://example.com/webhook"
+ },
+ "updated_at": "2019-06-03T00:57:16Z",
+ "created_at": "2019-06-03T00:57:16Z",
+ "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678",
+ "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test",
+ "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings",
+ "last_response": {
+ "code": null,
+ "status": "unused",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete a repository webhook",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": {
+ "post": {
+ "summary": "Ping a repository webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.18/webhooks/#ping-event) to be sent to the hook.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/ping-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#ping-a-repository-webhook"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": {
+ "post": {
+ "summary": "Test the push repository webhook",
+ "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/test-push-webhook",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#test-the-push-repository-webhook"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "webhooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/installation": {
+ "get": {
+ "summary": "Get a repository installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-repo-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-a-repository-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "account": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "repository_selection": "all",
+ "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "created_at": "2018-02-09T20:51:14Z",
+ "updated_at": "2018-02-09T20:51:14Z",
+ "single_file_name": "config.yml",
+ "app_slug": "github-actions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "description": "Moved Permanently"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/invitations": {
+ "get": {
+ "summary": "List repository invitations",
+ "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-invitations"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "invitee": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "inviter": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "invitee": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "inviter": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#list-repository-issues"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "collaborator"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "301": {
+ "description": "Moved Permanently"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ }
+ ],
+ "category": "issues"
+ }
+ },
+ "post": {
+ "summary": "Create an issue",
+ "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#create-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "closed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "author_association": "collaborator"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "issues",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/comments": {
+ "get": {
+ "summary": "List issue comments for a repository",
+ "description": "By default, Issue Comments are ordered by ascending ID.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-comments-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ }
+ ],
+ "category": "issues",
+ "subcategory": "comments"
+ }
+ },
+ "patch": {
+ "summary": "Update an issue comment",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#update-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#delete-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create reaction for an issue comment",
+ "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@2.18/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the issue comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/events": {
+ "get": {
+ "summary": "List issue events for a repository",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-events-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "assignee": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "assigner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "review_requester": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "requested_reviewer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "requested_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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ },
+ "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"
+ ]
+ },
+ "milestone": {
+ "title": "Issue Event Milestone",
+ "description": "Issue Event Milestone",
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "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"
+ ]
+ },
+ "rename": {
+ "title": "Issue Event Rename",
+ "description": "Issue Event Rename",
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from",
+ "to"
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "lock_reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDEwOklzc3VlRXZlbnQx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "closed",
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "created_at": "2011-04-14T16:00:49Z",
+ "issue": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "collaborator"
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-an-issue-event"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "event_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "assignee": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "assigner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "review_requester": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "requested_reviewer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "requested_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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ },
+ "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"
+ ]
+ },
+ "milestone": {
+ "title": "Issue Event Milestone",
+ "description": "Issue Event Milestone",
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "title"
+ ]
+ },
+ "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"
+ ]
+ },
+ "rename": {
+ "title": "Issue Event Rename",
+ "description": "Issue Event Rename",
+ "type": "object",
+ "properties": {
+ "from": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "from",
+ "to"
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "lock_reason": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "actor",
+ "event",
+ "commit_id",
+ "commit_url",
+ "created_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "node_id": "MDEwOklzc3VlRXZlbnQx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
+ "actor": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "event": "closed",
+ "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "created_at": "2011-04-14T16:00:49Z",
+ "issue": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "collaborator"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#get-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "closed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "author_association": "collaborator"
+ }
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "description": "Moved Permanently"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "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.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "issues",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update an issue",
+ "description": "Issue owners and users with push access can edit an issue.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#update-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "closed_by": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "author_association": "collaborator"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "301": {
+ "description": "Moved Permanently"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "issues",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/assignees": {
+ "post": {
+ "summary": "Add assignees to an issue",
+ "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/add-assignees",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#add-assignees-to-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "collaborator"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#remove-assignees-from-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ {
+ "login": "hubot",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/hubot",
+ "html_url": "https://github.com/hubot",
+ "followers_url": "https://api.github.com/users/hubot/followers",
+ "following_url": "https://api.github.com/users/hubot/following{/other_user}",
+ "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
+ "organizations_url": "https://api.github.com/users/hubot/orgs",
+ "repos_url": "https://api.github.com/users/hubot/repos",
+ "events_url": "https://api.github.com/users/hubot/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/hubot/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "author_association": "collaborator"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-comments"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/create-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-an-issue-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-issue-events"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Issue Event for Issue",
+ "description": "Issue Event for Issue",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "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
+ },
+ "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.\""
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-labels-for-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#add-labels-to-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#set-labels-for-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#remove-all-labels-from-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#remove-a-label-from-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/lock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#lock-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ }
+ ],
+ "category": "issues"
+ }
+ },
+ "delete": {
+ "summary": "Unlock an issue",
+ "description": "Users with push access can unlock an issue's conversation.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/unlock",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/issues/#unlock-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "issues",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": {
+ "get": {
+ "summary": "List reactions for an issue",
+ "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@2.18/rest/reference/issues).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create reaction for an issue",
+ "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@2.18/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-issue",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the issue.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/issues/{issue_number}/timeline": {
+ "get": {
+ "summary": "List timeline events for an issue",
+ "description": "",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-events-for-timeline",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-timeline-events-for-an-issue"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_number",
+ "description": "issue_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Issue Event for Issue",
+ "description": "Issue Event for Issue",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "actor": {
+ "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
+ },
+ "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.\""
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mockingbird",
+ "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```"
+ },
+ {
+ "required": false,
+ "name": "starfox",
+ "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-deploy-keys"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-deploy-key"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/keys/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-deploy-key"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-deploy-key"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-labels-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-a-label"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-a-label"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#delete-a-label"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-languages"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Language",
+ "description": "Language",
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer"
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "C": 78769,
+ "Python": 7769
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/license": {
+ "get": {
+ "summary": "Get the license for a repository",
+ "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.",
+ "tags": [
+ "licenses"
+ ],
+ "operationId": "licenses/get-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/licenses/#get-the-license-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "_links",
+ "git_url",
+ "html_url",
+ "download_url",
+ "name",
+ "path",
+ "sha",
+ "size",
+ "type",
+ "url",
+ "content",
+ "encoding",
+ "license"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "LICENSE",
+ "path": "LICENSE",
+ "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266",
+ "size": 1077,
+ "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master",
+ "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE",
+ "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266",
+ "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true",
+ "type": "file",
+ "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n",
+ "encoding": "base64",
+ "_links": {
+ "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master",
+ "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266",
+ "html": "https://github.com/benbalter/gman/blob/master/LICENSE"
+ },
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "licenses",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/merges": {
+ "post": {
+ "summary": "Merge a branch",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#merge-a-branch"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "mona@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ],
+ "stats": {
+ "additions": 104,
+ "deletions": 4,
+ "total": 108
+ },
+ "files": [
+ {
+ "filename": "file1.txt",
+ "additions": 10,
+ "deletions": 2,
+ "changes": 12,
+ "status": "modified",
+ "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt",
+ "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt",
+ "patch": "@@ -29,7 +29,7 @@\n....."
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string",
+ "example": "\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#perform-a-merge\""
+ }
+ }
+ },
+ "examples": {
+ "missing-base-response": {
+ "summary": "Missing base response",
+ "value": {
+ "message": "Base does not exist"
+ }
+ },
+ "missing-head-response": {
+ "summary": "Missing head response",
+ "value": {
+ "message": "Head does not exist"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Merge conflict response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string",
+ "example": "\"https://docs.github.com/enterprise-server@2.18/rest/reference/repos#perform-a-merge\""
+ }
+ }
+ },
+ "examples": {
+ "merge-conflict-response": {
+ "value": {
+ "message": "Merge Conflict"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-milestones"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-a-milestone"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#get-a-milestone"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#update-a-milestone"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#delete-a-milestone"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/issues#list-labels-for-issues-in-a-milestone"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "milestone_number",
+ "description": "milestone_number parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repository-notifications-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "all",
+ "description": "If `true`, show notifications marked as read.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "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
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Thread",
+ "description": "Thread",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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 Enterprise Server](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 Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/mark-repo-notifications-as-read",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#mark-repository-notifications-as-read"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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 Enterprise Server Pages site",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-github-pages-site"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "title": "Pages Source Hash",
+ "type": "object",
+ "properties": {
+ "branch": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "branch",
+ "path"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "status",
+ "cname",
+ "custom_404"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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": "/"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ },
+ "post": {
+ "summary": "Create a GitHub Pages site",
+ "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-github-pages-site"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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. Can be either `master` or `gh-pages`.",
+ "enum": [
+ "master",
+ "gh-pages"
+ ]
+ },
+ "path": {
+ "type": "string",
+ "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
+ "enum": [
+ "/",
+ "/docs"
+ ],
+ "default": "/"
+ }
+ },
+ "required": [
+ "branch"
+ ]
+ }
+ },
+ "required": [
+ "source"
+ ]
+ },
+ "example": {
+ "source": {
+ "branch": "master",
+ "path": "/docs"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "title": "Pages Source Hash",
+ "type": "object",
+ "properties": {
+ "branch": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "branch",
+ "path"
+ ]
+ }
+ },
+ "required": [
+ "url",
+ "status",
+ "cname",
+ "custom_404"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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": "/"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "switcheroo",
+ "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "mister-fantastic",
+ "note": "The GitHub Pages API contains two additional fields in responses, which developers can preview: `html_url` and `source`. To see these two new fields, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mister-fantastic-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ },
+ "put": {
+ "summary": "Update information about a GitHub Pages site",
+ "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/update-information-about-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-information-about-a-github-pages-site"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ }
+ ],
+ "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"
+ ]
+ }
+ }
+ },
+ "example": {
+ "source": "master /docs"
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "mister-fantastic",
+ "note": "The GitHub Pages API contains two additional fields in responses, which developers can preview: `html_url` and `source`. To see these two new fields, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mister-fantastic-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ },
+ "delete": {
+ "summary": "Delete a GitHub Enterprise Server Pages site",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/delete-pages-site",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-github-pages-site"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "switcheroo",
+ "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/builds": {
+ "get": {
+ "summary": "List GitHub Enterprise Server Pages builds",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-pages-builds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-github-pages-builds"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
+ "status": "built",
+ "error": {
+ "message": null
+ },
+ "pusher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
+ "duration": 2104,
+ "created_at": "2014-02-10T19:00:49Z",
+ "updated_at": "2014-02-10T19:00:51Z"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ },
+ "post": {
+ "summary": "Request a GitHub Enterprise Server Pages build",
+ "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/request-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#request-a-github-pages-build"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest",
+ "status": "queued"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-latest-pages-build"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
+ "status": "built",
+ "error": {
+ "message": null
+ },
+ "pusher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
+ "duration": 2104,
+ "created_at": "2014-02-10T19:00:49Z",
+ "updated_at": "2014-02-10T19:00:51Z"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pages/builds/{build_id}": {
+ "get": {
+ "summary": "Get GitHub Enterprise Server Pages build",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-pages-build",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-github-pages-build"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "build_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
+ "status": "built",
+ "error": {
+ "message": null
+ },
+ "pusher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b",
+ "duration": 2104,
+ "created_at": "2014-02-10T19:00:49Z",
+ "updated_at": "2014-02-10T19:00:51Z"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "pages"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pre-receive-hooks": {
+ "get": {
+ "summary": "List pre-receive hooks for a repository",
+ "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.",
+ "operationId": "enterprise-admin/list-pre-receive-hooks-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": {
+ "get": {
+ "summary": "Get a pre-receive hook for a repository",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ }
+ },
+ "patch": {
+ "summary": "Update pre-receive hook enforcement for a repository",
+ "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`",
+ "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "enabled",
+ "configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enforcement": {
+ "description": "The state of enforcement for the hook on this repository.",
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "enforcement": "enabled"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ }
+ },
+ "delete": {
+ "summary": "Remove pre-receive hook enforcement for a repository",
+ "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.",
+ "operationId": "enterprise-admin/remove-pre-receive-hook-enforcement-for-repo",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Responds with effective values inherited from owner and/or global level.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "configuration_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 42,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "repo-pre-receive-hooks"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/projects": {
+ "get": {
+ "summary": "List repository projects",
+ "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#list-repository-projects"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create a repository project",
+ "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#create-a-repository-project"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ }
+ },
+ "/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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#list-pull-requests"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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",
+ "parent": null
+ }
+ ],
+ "head": {
+ "label": "octocat:new-topic",
+ "ref": "new-topic",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ },
+ "base": {
+ "label": "octocat:master",
+ "ref": "master",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ },
+ "_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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ }
+ ],
+ "category": "pulls"
+ }
+ },
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud. You can create a new pull request. This endpoint triggers [notifications](https://docs.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#create-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "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"
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "license": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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"
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "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",
+ "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,
+ "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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "_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
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ }
+ ],
+ "category": "pulls"
+ }
+ }
+ },
+ "/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.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-review-comments-in-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#update-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```"
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#delete-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#review-comments).",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/list-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-pull-request-review-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a pull request review comment",
+ "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.",
+ "tags": [
+ "reactions"
+ ],
+ "operationId": "reactions/create-for-pull-request-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-pull-request-review-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the pull request review comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Reaction exists",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Reaction created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}": {
+ "get": {
+ "summary": "Get a pull request",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@2.18/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#get-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "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"
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "license": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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"
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "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",
+ "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,
+ "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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "_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
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "500": {
+ "description": "Internal Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "pulls",
+ "subcategory": null
+ }
+ },
+ "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, GitHub Enterprise Server 2.17+, and GitHub Enterprise Cloud.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#update-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "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"
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "license": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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"
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "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",
+ "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,
+ "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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "_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
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "shadow-cat",
+ "note": "The Draft Pull Request API is currently available for developers to preview. You can use this API to create a draft pull request or see whether a pull request is in draft state. See the [blog post](https://developer.github.com/changes/2019-02-14-draft-pull-requests) preview for more details. To access the new `draft` parameter during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.shadow-cat-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "sailor-v",
+ "note": "You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.sailor-v-preview+json\n```"
+ }
+ ],
+ "category": "pulls"
+ }
+ }
+ },
+ "/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.\n\nLists all review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**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.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-review-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-review-comments-on-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "pulls",
+ "subcategory": "comments"
+ }
+ },
+ "post": {
+ "summary": "Create a review comment for a pull request (alternative)",
+ "description": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@2.18/rest/reference/issues#create-an-issue-comment).\"\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "pulls/create-review-comment-alternative",
+ "tags": [
+ "pulls"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#create-a-review-comment-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "pull_request_review_id": {
+ "type": "integer"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "diff_hunk": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "position": {
+ "type": "integer"
+ },
+ "original_position": {
+ "type": "integer"
+ },
+ "commit_id": {
+ "type": "string"
+ },
+ "original_commit_id": {
+ "type": "string"
+ },
+ "in_reply_to_id": {
+ "type": "integer"
+ },
+ "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"
+ }
+ }
+ },
+ "body": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "pull_request_url": {
+ "type": "string"
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "self": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ }
+ },
+ "html": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ }
+ },
+ "pull_request": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The text of the comment."
+ },
+ "in_reply_to": {
+ "type": "integer",
+ "description": "The comment ID to reply to. **Note**: This must be the ID of a _top-level comment_, not a reply to that comment. Replies to replies are not supported."
+ }
+ },
+ "required": [
+ "body"
+ ]
+ },
+ "example": {
+ "body": "Nice change"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "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.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-reply-for-review-comment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#create-a-reply-for-a-review-comment"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits) endpoint.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#list-commits-on-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
+ "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
+ "commit": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "author": {
+ "name": "Monalisa Octocat",
+ "email": "support@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "support@github.com",
+ "date": "2011-04-14T16:00:49Z"
+ },
+ "message": "Fix all the bugs",
+ "tree": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ },
+ "comment_count": 0,
+ "verification": {
+ "verified": false,
+ "reason": "unsigned",
+ "signature": null,
+ "payload": null
+ }
+ },
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "committer": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "parents": [
+ {
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "pulls",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/files": {
+ "get": {
+ "summary": "List pull requests files",
+ "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-files",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#list-pull-requests-files"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "pulls",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/merge": {
+ "get": {
+ "summary": "Check if a pull request has been merged",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/check-if-merged",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#check-if-a-pull-request-has-been-merged"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response if pull request has been merged"
+ },
+ "404": {
+ "description": "Response if pull request has not been merged"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "pulls",
+ "subcategory": null
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/merge",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/pulls/#merge-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "response-if-merge-was-successful": {
+ "value": {
+ "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+ "merged": true,
+ "message": "Pull Request successfully merged"
+ }
+ }
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Response if merge cannot be performed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-merge-cannot-be-performed": {
+ "value": {
+ "message": "Pull Request is not mergeable"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Response if sha was provided and pull request head did not match",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-sha-was-provided-and-pull-request-head-did-not-match": {
+ "value": {
+ "message": "Head branch was modified. Review and try the merge again."
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "pulls",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": {
+ "get": {
+ "summary": "List requested reviewers for a pull request",
+ "description": "",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/list-requested-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-requested-reviewers-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/reference/guides#dealing-with-abuse-rate-limits)\" for details.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/request-reviewers",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#request-reviewers-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_reviewers": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "requested_teams": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "head": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "base": {
+ "type": "object",
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "ref": {
+ "type": "string"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "sha": {
+ "type": "string"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "label",
+ "ref",
+ "repo",
+ "sha",
+ "user"
+ ]
+ },
+ "_links": {
+ "type": "object",
+ "properties": {
+ "comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "commits": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "statuses": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "issue": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comments": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "review_comment": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "self": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "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",
+ "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,
+ "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,
+ "allow_squash_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,
+ "anonymous_access_enabled": false
+ }
+ },
+ "_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
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Response if user is not a collaborator"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-reviews-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The list of reviews returns in chronological order.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/create-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#create-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "commit_id": {
+ "type": "string",
+ "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value."
+ },
+ "body": {
+ "type": "string",
+ "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review."
+ },
+ "event": {
+ "type": "string",
+ "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
+ "enum": [
+ "APPROVE",
+ "REQUEST_CHANGES",
+ "COMMENT"
+ ]
+ },
+ "comments": {
+ "type": "array",
+ "description": "Use the following table to specify the location, destination, and contents of the draft review comment.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The relative path to the file that necessitates a review comment."
+ },
+ "position": {
+ "type": "integer",
+ "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below."
+ },
+ "body": {
+ "type": "string",
+ "description": "Text of the review comment."
+ },
+ "line": {
+ "type": "integer",
+ "example": "28"
+ },
+ "side": {
+ "type": "string",
+ "example": "\"RIGHT\""
+ },
+ "start_line": {
+ "type": "integer",
+ "example": "26"
+ },
+ "start_side": {
+ "type": "string",
+ "example": "\"LEFT\""
+ }
+ },
+ "required": [
+ "path",
+ "body"
+ ]
+ }
+ }
+ }
+ },
+ "example": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#get-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#update-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#delete-a-pending-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-comments-for-a-pull-request-review"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "html": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ },
+ "pull_request": {
+ "title": "Link",
+ "description": "Hypermedia Link",
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "href"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.",
+ "tags": [
+ "pulls"
+ ],
+ "operationId": "pulls/dismiss-review",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#dismiss-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/pulls#submit-a-review-for-a-pull-request"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "review_id",
+ "description": "review_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/v3/pulls/#update-a-pull-request-branch"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pull_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "expected_head_sha": {
+ "type": "string",
+ "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref."
+ }
+ }
+ },
+ "example": {
+ "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "message": "Updating pull request branch.",
+ "url": "https://github.com/repos/octocat/Hello-World/pulls/53"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "lydian",
+ "note": "Updating the pull request branch with latest upstream changes is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.lydian-preview+json\n```"
+ }
+ ],
+ "category": "pulls",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/readme": {
+ "get": {
+ "summary": "Get a repository README",
+ "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-readme",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "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/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-releases",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-releases"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-release"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World/releases/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release-asset",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-release-asset"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "302": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-release-asset"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-release-asset"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "asset_id",
+ "description": "asset_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-latest-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-latest-release"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-release-by-tag-name"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "tag",
+ "description": "tag+ parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#hypermedia).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-release",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-release"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#hypermedia).",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#update-a-release"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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
+ },
+ "assets": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-release"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-release-assets"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server 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://docs.github.com/enterprise-server@2.18/rest/reference/repos#upload-a-release-asset"
+ },
+ "servers": [
+ {
+ "url": "{origin}",
+ "variables": {
+ "origin": {
+ "default": "https://uploads.github.com",
+ "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint"
+ }
+ }
+ }
+ ],
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "release_id",
+ "description": "release_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "content_type",
+ "size",
+ "state",
+ "url",
+ "node_id",
+ "download_count",
+ "label",
+ "uploader",
+ "browser_download_url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-stargazers-for-repo",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-stargazers"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "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
+ }
+ ]
+ }
+ }
+ },
+ "application/vnd.github.v3.star+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Stargazer",
+ "description": "Stargazer",
+ "type": "object",
+ "properties": {
+ "starred_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "starred_at",
+ "user"
+ ]
+ }
+ },
+ "examples": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-weekly-commit-activity"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Code Frequency Stat",
+ "description": "Code Frequency Stat",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ [
+ 1302998400,
+ 1124,
+ -435
+ ]
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-last-year-of-commit-activity"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "days": [
+ 0,
+ 3,
+ 26,
+ 20,
+ 39,
+ 1,
+ 0
+ ],
+ "total": 89,
+ "week": 1336280400
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": "statistics"
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/stats/contributors": {
+ "get": {
+ "summary": "Get all contributor commit activity",
+ "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-contributors-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-all-contributor-commit-activity"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Contributor Activity",
+ "description": "Contributor Activity",
+ "type": "object",
+ "properties": {
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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`.\n\nThe array order is oldest week (index 0) to most recent week.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-participation-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-weekly-commit-count"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The array order is oldest week (index 0) to most recent week.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Participation Stats",
+ "type": "object",
+ "properties": {
+ "all": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ },
+ "owner": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-punch-card-stats",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-the-hourly-commit-count-for-each-day"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Code Frequency Stat",
+ "description": "Code Frequency Stat",
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ [
+ 0,
+ 0,
+ 5
+ ],
+ [
+ 0,
+ 1,
+ 43
+ ],
+ [
+ 0,
+ 2,
+ 21
+ ]
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-commit-status",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#create-a-commit-status"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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": {
+ "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
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-watchers"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#get-a-repository-subscription"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response if you subscribe to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "response-if-you-subscribe-to-the-repository": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/repos/octocat/example/subscription",
+ "repository_url": "https://api.github.com/repos/octocat/example"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Response if you don't subscribe to the repository"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#delete-a-repository-subscription) completely.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/set-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#set-a-repository-subscription"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "subscribed": true,
+ "ignored": false,
+ "reason": null,
+ "created_at": "2012-10-06T21:34:12Z",
+ "url": "https://api.github.com/repos/octocat/example/subscription",
+ "repository_url": "https://api.github.com/repos/octocat/example"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#set-a-repository-subscription).",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/delete-repo-subscription",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#delete-a-repository-subscription"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-tags"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/tarball/{ref}": {
+ "get": {
+ "summary": "Download a repository archive (tar)",
+ "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#download-a-repository-archive"
+ },
+ "operationId": "repos/download-tarball-archive",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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://docs.github.com/enterprise-server@2.18/v3/repos/#list-repository-teams"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/topics": {
+ "get": {
+ "summary": "Get all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/get-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#get-all-repository-topics"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Topic",
+ "description": "A topic aggregates entities that are related to a subject.",
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ },
+ "put": {
+ "summary": "Replace all repository topics",
+ "description": "",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/replace-all-topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#replace-all-repository-topics"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Topic",
+ "description": "A topic aggregates entities that are related to a subject.",
+ "type": "object",
+ "properties": {
+ "names": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/transfer": {
+ "post": {
+ "summary": "Transfer a repository",
+ "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/transfer",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#transfer-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/vulnerability-alerts": {
+ "put": {
+ "summary": "Enable vulnerability alerts",
+ "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/enable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#enable-vulnerability-alerts"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "dorian",
+ "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Disable vulnerability alerts",
+ "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/disable-vulnerability-alerts",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#disable-vulnerability-alerts"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "dorian",
+ "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repos/{owner}/{repo}/zipball/{ref}": {
+ "get": {
+ "summary": "Download a repository archive (zip)",
+ "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "tags": [
+ "repos"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#download-a-repository-archive"
+ },
+ "operationId": "repos/download-zipball-archive",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-using-template",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#create-a-repository-using-a-template"
+ },
+ "parameters": [
+ {
+ "name": "template_owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "template_repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "owner": {
+ "type": "string",
+ "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the new repository."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short description of the new repository."
+ },
+ "include_all_branches": {
+ "type": "boolean",
+ "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.",
+ "default": false
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Either `true` to create a new private repository or `false` to create a new public one.",
+ "default": false
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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"
+ },
+ "anonymous_access_enabled": false,
+ "template_repository": {
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "baptiste",
+ "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/repositories": {
+ "get": {
+ "summary": "List public repositories",
+ "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/repos/#list-public-repositories"
+ },
+ "parameters": [
+ {
+ "name": "since",
+ "description": "A repository ID. Only return repositories with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "visibility",
+ "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "public",
+ "example": "all",
+ "enum": [
+ "all",
+ "public"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/code": {
+ "get": {
+ "summary": "Search code",
+ "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-code"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "indexed"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "score",
+ "name",
+ "path",
+ "sha",
+ "git_url",
+ "html_url",
+ "url",
+ "repository"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/commits": {
+ "get": {
+ "summary": "Search commits",
+ "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/commits",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-commits"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "author-date",
+ "committer-date"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "committer",
+ "comment_count",
+ "message",
+ "tree",
+ "url"
+ ]
+ },
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "committer": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "parents": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "sha": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "score": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "sha",
+ "node_id",
+ "url",
+ "html_url",
+ "author",
+ "committer",
+ "parents",
+ "comments_url",
+ "commit",
+ "repository",
+ "score"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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=="
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "cloak",
+ "note": "The Commit Search API is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2017-01-05-commit-search-api/) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/issues": {
+ "get": {
+ "summary": "Search issues and pull requests",
+ "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/issues-and-pull-requests",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-issues-and-pull-requests"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "comments",
+ "reactions",
+ "reactions-+1",
+ "reactions--1",
+ "reactions-smile",
+ "reactions-thinking_face",
+ "reactions-heart",
+ "reactions-tada",
+ "interactions",
+ "created",
+ "updated"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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
+ },
+ "nullable": true
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 280,
+ "incomplete_results": false,
+ "items": [
+ {
+ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132",
+ "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit",
+ "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}",
+ "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments",
+ "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events",
+ "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132",
+ "id": 35802,
+ "node_id": "MDU6SXNzdWUzNTgwMg==",
+ "number": 132,
+ "title": "Line Number Indexes Beyond 20 Not Displayed",
+ "user": {
+ "login": "Nick3C",
+ "id": 90254,
+ "node_id": "MDQ6VXNlcjkwMjU0",
+ "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/Nick3C",
+ "html_url": "https://github.com/Nick3C",
+ "followers_url": "https://api.github.com/users/Nick3C/followers",
+ "following_url": "https://api.github.com/users/Nick3C/following{/other_user}",
+ "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions",
+ "organizations_url": "https://api.github.com/users/Nick3C/orgs",
+ "repos_url": "https://api.github.com/users/Nick3C/repos",
+ "events_url": "https://api.github.com/users/Nick3C/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/Nick3C/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "labels": [
+ {
+ "id": 4,
+ "node_id": "MDU6TGFiZWw0",
+ "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug",
+ "name": "bug",
+ "color": "ff0000"
+ }
+ ],
+ "state": "open",
+ "assignee": null,
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "comments": 15,
+ "created_at": "2009-07-12T20:10:41Z",
+ "updated_at": "2009-07-19T09:23:43Z",
+ "closed_at": null,
+ "pull_request": {
+ "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
+ },
+ "body": "...",
+ "score": 1,
+ "locked": true,
+ "author_association": "collaborator"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/labels": {
+ "get": {
+ "summary": "Search labels",
+ "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/labels",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-labels"
+ },
+ "parameters": [
+ {
+ "name": "repository_id",
+ "description": "The id of the repository.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "q",
+ "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query).",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "name",
+ "color",
+ "default",
+ "description",
+ "score"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/repositories": {
+ "get": {
+ "summary": "Search repositories",
+ "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/repos",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-repositories"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "stars",
+ "forks",
+ "help-wanted-issues",
+ "updated"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/topics": {
+ "get": {
+ "summary": "Search topics",
+ "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/topics",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-topics"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/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": {
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```"
+ }
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/search/users": {
+ "get": {
+ "summary": "Search users",
+ "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@2.18/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.",
+ "tags": [
+ "search"
+ ],
+ "operationId": "search/users",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/search/#search-users"
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@2.18/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@2.18/rest/reference/search#ranking-search-results)",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "followers",
+ "repositories",
+ "joined"
+ ]
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "total_count": {
+ "type": "integer"
+ },
+ "incomplete_results": {
+ "type": "boolean"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "search",
+ "subcategory": null
+ }
+ }
+ },
+ "/setup/api/configcheck": {
+ "get": {
+ "summary": "Get the configuration status",
+ "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |",
+ "operationId": "enterprise-admin/get-configuration-status",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-the-configuration-status"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "progress": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "key"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "status": "running",
+ "progress": [
+ {
+ "status": "DONE",
+ "key": "Appliance core components"
+ },
+ {
+ "status": "DONE",
+ "key": "GitHub utilities"
+ },
+ {
+ "status": "DONE",
+ "key": "GitHub applications"
+ },
+ {
+ "status": "CONFIGURING",
+ "key": "GitHub services"
+ },
+ {
+ "status": "PENDING",
+ "key": "Reloading appliance services"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/configure": {
+ "post": {
+ "summary": "Start a configuration process",
+ "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:",
+ "operationId": "enterprise-admin/start-configuration-process",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#start-a-configuration-process"
+ },
+ "responses": {
+ "202": {
+ "description": "response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/maintenance": {
+ "get": {
+ "summary": "Get the maintenance status",
+ "description": "Check your installation's maintenance status:",
+ "operationId": "enterprise-admin/get-maintenance-status",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-the-maintenance-status"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "scheduled_time": {
+ "type": "string"
+ },
+ "connection_services": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "number"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "status": "scheduled",
+ "scheduled_time": "Tuesday, January 22 at 15 => 34 -0800",
+ "connection_services": [
+ {
+ "name": "git operations",
+ "number": 0
+ },
+ {
+ "name": "mysql queries",
+ "number": 233
+ },
+ {
+ "name": "resque jobs",
+ "number": 54
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ },
+ "post": {
+ "summary": "Enable or disable maintenance mode",
+ "description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).",
+ "operationId": "enterprise-admin/enable-or-disable-maintenance-mode",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "scheduled_time": {
+ "type": "string"
+ },
+ "connection_services": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "number": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "number"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "status": "scheduled",
+ "scheduled_time": "Tuesday, January 22 at 15 => 34 -0800",
+ "connection_services": [
+ {
+ "name": "git operations",
+ "number": 0
+ },
+ {
+ "name": "mysql queries",
+ "number": 233
+ },
+ {
+ "name": "resque jobs",
+ "number": 54
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "maintenance": {
+ "type": "string",
+ "description": "A JSON string with the attributes `enabled` and `when`."
+ }
+ },
+ "required": [
+ "maintenance"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/settings": {
+ "get": {
+ "summary": "Get settings",
+ "description": "",
+ "operationId": "enterprise-admin/get-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-settings"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enterprise": {
+ "type": "object",
+ "properties": {
+ "private_mode": {
+ "type": "boolean"
+ },
+ "public_pages": {
+ "type": "boolean"
+ },
+ "subdomain_isolation": {
+ "type": "boolean"
+ },
+ "signup_enabled": {
+ "type": "boolean"
+ },
+ "github_hostname": {
+ "type": "string"
+ },
+ "identicons_host": {
+ "type": "string"
+ },
+ "http_proxy": {
+ "nullable": true,
+ "type": "string"
+ },
+ "auth_mode": {
+ "type": "string"
+ },
+ "expire_sessions": {
+ "type": "boolean"
+ },
+ "admin_password": {
+ "nullable": true,
+ "type": "string"
+ },
+ "configuration_id": {
+ "type": "integer"
+ },
+ "configuration_run_count": {
+ "type": "integer"
+ },
+ "avatar": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "uri": {
+ "type": "string"
+ }
+ }
+ },
+ "customer": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "uuid": {
+ "type": "string"
+ },
+ "secret_key_data": {
+ "type": "string"
+ },
+ "public_key_data": {
+ "type": "string"
+ }
+ }
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "seats": {
+ "type": "integer"
+ },
+ "evaluation": {
+ "type": "boolean"
+ },
+ "perpetual": {
+ "type": "boolean"
+ },
+ "unlimited_seating": {
+ "type": "boolean"
+ },
+ "support_key": {
+ "type": "string"
+ },
+ "ssh_allowed": {
+ "type": "boolean"
+ },
+ "cluster_support": {
+ "type": "boolean"
+ },
+ "expire_at": {
+ "type": "string"
+ }
+ }
+ },
+ "github_ssl": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "cert": {
+ "nullable": true,
+ "type": "string"
+ },
+ "key": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "ldap": {
+ "type": "object",
+ "properties": {
+ "host": {
+ "nullable": true,
+ "type": "string"
+ },
+ "port": {
+ "type": "integer"
+ },
+ "base": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "uid": {
+ "nullable": true,
+ "type": "string"
+ },
+ "bind_dn": {
+ "nullable": true,
+ "type": "string"
+ },
+ "password": {
+ "nullable": true,
+ "type": "string"
+ },
+ "method": {
+ "type": "string"
+ },
+ "search_strategy": {
+ "type": "string"
+ },
+ "user_groups": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "admin_group": {
+ "nullable": true,
+ "type": "string"
+ },
+ "virtual_attribute_enabled": {
+ "type": "boolean"
+ },
+ "recursive_group_search": {
+ "type": "boolean"
+ },
+ "posix_support": {
+ "type": "boolean"
+ },
+ "user_sync_emails": {
+ "type": "boolean"
+ },
+ "user_sync_keys": {
+ "type": "boolean"
+ },
+ "user_sync_interval": {
+ "type": "integer"
+ },
+ "team_sync_interval": {
+ "type": "integer"
+ },
+ "sync_enabled": {
+ "type": "boolean"
+ },
+ "reconciliation": {
+ "type": "object",
+ "properties": {
+ "user": {
+ "nullable": true,
+ "type": "string"
+ },
+ "org": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "profile": {
+ "type": "object",
+ "properties": {
+ "uid": {
+ "type": "string"
+ },
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "mail": {
+ "nullable": true,
+ "type": "string"
+ },
+ "key": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "cas": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "saml": {
+ "type": "object",
+ "properties": {
+ "sso_url": {
+ "nullable": true,
+ "type": "string"
+ },
+ "certificate": {
+ "nullable": true,
+ "type": "string"
+ },
+ "certificate_path": {
+ "nullable": true,
+ "type": "string"
+ },
+ "issuer": {
+ "nullable": true,
+ "type": "string"
+ },
+ "idp_initiated_sso": {
+ "type": "boolean"
+ },
+ "disable_admin_demote": {
+ "type": "boolean"
+ }
+ }
+ },
+ "github_oauth": {
+ "type": "object",
+ "properties": {
+ "client_id": {
+ "type": "string"
+ },
+ "client_secret": {
+ "type": "string"
+ },
+ "organization_name": {
+ "type": "string"
+ },
+ "organization_team": {
+ "type": "string"
+ }
+ }
+ },
+ "smtp": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "address": {
+ "type": "string"
+ },
+ "authentication": {
+ "type": "string"
+ },
+ "port": {
+ "type": "string"
+ },
+ "domain": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "user_name": {
+ "type": "string"
+ },
+ "enable_starttls_auto": {
+ "type": "boolean"
+ },
+ "password": {
+ "type": "string"
+ },
+ "discard-to-noreply-address": {
+ "type": "boolean"
+ },
+ "support_address": {
+ "type": "string"
+ },
+ "support_address_type": {
+ "type": "string"
+ },
+ "noreply_address": {
+ "type": "string"
+ }
+ }
+ },
+ "ntp": {
+ "type": "object",
+ "properties": {
+ "primary_server": {
+ "type": "string"
+ },
+ "secondary_server": {
+ "type": "string"
+ }
+ }
+ },
+ "timezone": {
+ "nullable": true,
+ "type": "string"
+ },
+ "snmp": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "community": {
+ "type": "string"
+ }
+ }
+ },
+ "syslog": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "server": {
+ "nullable": true,
+ "type": "string"
+ },
+ "protocol_name": {
+ "type": "string"
+ }
+ }
+ },
+ "assets": {
+ "nullable": true,
+ "type": "string"
+ },
+ "pages": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "collectd": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "server": {
+ "nullable": true,
+ "type": "string"
+ },
+ "port": {
+ "type": "integer"
+ },
+ "encryption": {
+ "nullable": true,
+ "type": "string"
+ },
+ "username": {
+ "nullable": true,
+ "type": "string"
+ },
+ "password": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "mapping": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "tileserver": {
+ "nullable": true,
+ "type": "string"
+ },
+ "basemap": {
+ "type": "string"
+ },
+ "token": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "load_balancer": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "run_list": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "enterprise": {
+ "private_mode": false,
+ "public_pages": false,
+ "subdomain_isolation": true,
+ "signup_enabled": false,
+ "github_hostname": "ghe.local",
+ "identicons_host": "dotcom",
+ "http_proxy": null,
+ "auth_mode": "default",
+ "expire_sessions": false,
+ "admin_password": null,
+ "configuration_id": 1401777404,
+ "configuration_run_count": 4,
+ "avatar": {
+ "enabled": false,
+ "uri": ""
+ },
+ "customer": {
+ "name": "GitHub",
+ "email": "stannis@themannis.biz",
+ "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9",
+ "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n",
+ "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n"
+ },
+ "license": {
+ "seats": 0,
+ "evaluation": false,
+ "perpetual": false,
+ "unlimited_seating": true,
+ "support_key": "ssh-rsa AAAAB3N....",
+ "ssh_allowed": true,
+ "cluster_support": false,
+ "expire_at": "2016-04-27T00:00:00-07:00"
+ },
+ "github_ssl": {
+ "enabled": false,
+ "cert": null,
+ "key": null
+ },
+ "ldap": {
+ "host": null,
+ "port": 0,
+ "base": [
+
+ ],
+ "uid": null,
+ "bind_dn": null,
+ "password": null,
+ "method": "Plain",
+ "search_strategy": "detect",
+ "user_groups": [
+
+ ],
+ "admin_group": null,
+ "virtual_attribute_enabled": false,
+ "recursive_group_search": false,
+ "posix_support": true,
+ "user_sync_emails": false,
+ "user_sync_keys": false,
+ "user_sync_interval": 4,
+ "team_sync_interval": 4,
+ "sync_enabled": false,
+ "reconciliation": {
+ "user": null,
+ "org": null
+ },
+ "profile": {
+ "uid": "uid",
+ "name": null,
+ "mail": null,
+ "key": null
+ }
+ },
+ "cas": {
+ "url": null
+ },
+ "saml": {
+ "sso_url": null,
+ "certificate": null,
+ "certificate_path": null,
+ "issuer": null,
+ "idp_initiated_sso": false,
+ "disable_admin_demote": false
+ },
+ "github_oauth": {
+ "client_id": "12313412",
+ "client_secret": "kj123131132",
+ "organization_name": "Homestar Runners",
+ "organization_team": "homestarrunners/characters"
+ },
+ "smtp": {
+ "enabled": true,
+ "address": "smtp.example.com",
+ "authentication": "plain",
+ "port": "1234",
+ "domain": "blah",
+ "username": "foo",
+ "user_name": "mr_foo",
+ "enable_starttls_auto": true,
+ "password": "bar",
+ "discard-to-noreply-address": true,
+ "support_address": "enterprise@github.com",
+ "support_address_type": "email",
+ "noreply_address": "noreply@github.com"
+ },
+ "ntp": {
+ "primary_server": "0.pool.ntp.org",
+ "secondary_server": "1.pool.ntp.org"
+ },
+ "timezone": null,
+ "snmp": {
+ "enabled": false,
+ "community": ""
+ },
+ "syslog": {
+ "enabled": false,
+ "server": null,
+ "protocol_name": "udp"
+ },
+ "assets": null,
+ "pages": {
+ "enabled": true
+ },
+ "collectd": {
+ "enabled": false,
+ "server": null,
+ "port": 0,
+ "encryption": null,
+ "username": null,
+ "password": null
+ },
+ "mapping": {
+ "enabled": true,
+ "tileserver": null,
+ "basemap": "company.map-qsz2zrvs",
+ "token": null
+ },
+ "load_balancer": null
+ },
+ "run_list": [
+ "recipe[enterprise-configure]"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ },
+ "put": {
+ "summary": "Set settings",
+ "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-settings).",
+ "operationId": "enterprise-admin/set-settings",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#set-settings"
+ },
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "settings": {
+ "type": "string",
+ "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify."
+ }
+ },
+ "required": [
+ "settings"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/settings/authorized-keys": {
+ "get": {
+ "summary": "Get all authorized SSH keys",
+ "description": "",
+ "operationId": "enterprise-admin/get-all-authorized-ssh-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-all-authorized-ssh-keys"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "pretty-print": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ },
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ },
+ "post": {
+ "summary": "Add an authorized SSH key",
+ "description": "",
+ "operationId": "enterprise-admin/add-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#add-an-authorized-ssh-key"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "pretty-print": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ },
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "The path to the public SSH key."
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ },
+ "delete": {
+ "summary": "Remove an authorized SSH key",
+ "description": "",
+ "operationId": "enterprise-admin/remove-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#remove-an-authorized-ssh-key"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "pretty-print": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ },
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "The path to the public SSH key."
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/start": {
+ "post": {
+ "summary": "Create a GitHub license",
+ "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#get-settings).",
+ "operationId": "enterprise-admin/create-enterprise-server-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#create-a-github-enterprise-server-license"
+ },
+ "responses": {
+ "202": {
+ "description": "response"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your _.ghl_ license file."
+ },
+ "password": {
+ "type": "string",
+ "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter."
+ },
+ "settings": {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings."
+ }
+ },
+ "required": [
+ "license"
+ ]
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/upgrade": {
+ "post": {
+ "summary": "Upgrade a license",
+ "description": "This API upgrades your license and also triggers the configuration process:",
+ "operationId": "enterprise-admin/upgrade-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#upgrade-a-license"
+ },
+ "responses": {
+ "202": {
+ "description": "response"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your new _.ghl_ license file."
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/teams/{team_id}": {
+ "get": {
+ "summary": "Get a team",
+ "description": "",
+ "operationId": "teams/get",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#get-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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",
+ "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"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update a team",
+ "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.",
+ "operationId": "teams/update",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#update-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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",
+ "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"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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. **Note**: You must pass the `hellcat-preview` media type to use this parameter."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "example": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Delete a team",
+ "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well.",
+ "operationId": "teams/delete",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#delete-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/discussions": {
+ "get": {
+ "summary": "List discussions",
+ "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/list-discussions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#list-discussions"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "comments_count": 0,
+ "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "teams/create-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-discussion"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "comments_count": 0,
+ "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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."
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}": {
+ "get": {
+ "summary": "Get a discussion",
+ "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/get-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-a-discussion"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "comments_count": 0,
+ "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/update-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#update-a-discussion"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/delete-discussion",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#delete-a-discussion"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/comments": {
+ "get": {
+ "summary": "List discussion comments",
+ "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/list-discussion-comments",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#list-discussion-comments"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Team Discussion Comment",
+ "description": "A reply to a discussion within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "discussion_url",
+ "html_url",
+ "node_id",
+ "number",
+ "updated_at",
+ "url"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Do you like apples?",
+ "body_html": "Do you like apples?
",
+ "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
+ "created_at": "2018-01-15T23:53:58Z",
+ "last_edited_at": null,
+ "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
+ "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "number": 1,
+ "updated_at": "2018-01-15T23:53:58Z",
+ "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" for details.",
+ "operationId": "teams/create-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Discussion Comment",
+ "description": "A reply to a discussion within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "discussion_url",
+ "html_url",
+ "node_id",
+ "number",
+ "updated_at",
+ "url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Do you like apples?",
+ "body_html": "Do you like apples?
",
+ "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
+ "created_at": "2018-01-15T23:53:58Z",
+ "last_edited_at": null,
+ "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
+ "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "number": 1,
+ "updated_at": "2018-01-15T23:53:58Z",
+ "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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?"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "triggersNotification": true,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "get": {
+ "summary": "Get a discussion comment",
+ "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/get-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Discussion Comment",
+ "description": "A reply to a discussion within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "discussion_url",
+ "html_url",
+ "node_id",
+ "number",
+ "updated_at",
+ "url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "body": "Do you like apples?",
+ "body_html": "Do you like apples?
",
+ "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
+ "created_at": "2018-01-15T23:53:58Z",
+ "last_edited_at": null,
+ "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
+ "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "number": 1,
+ "updated_at": "2018-01-15T23:53:58Z",
+ "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/update-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#update-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Discussion Comment",
+ "description": "A reply to a discussion within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "discussion_url",
+ "html_url",
+ "node_id",
+ "number",
+ "updated_at",
+ "url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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?"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "teams/delete-discussion-comment",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#delete-a-discussion-comment"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "discussion-comments"
+ }
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": {
+ "get": {
+ "summary": "List reactions for a team discussion comment",
+ "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "reactions/list-for-team-discussion-comment",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-team-discussion-comment"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a team discussion comment",
+ "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
+ "operationId": "reactions/create-for-team-discussion-comment",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-team-discussion-comment"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "comment_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the team discussion comment.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/discussions/{discussion_number}/reactions": {
+ "get": {
+ "summary": "List reactions for a team discussion",
+ "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "reactions/list-for-team-discussion",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#list-reactions-for-a-team-discussion"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "content",
+ "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create reaction for a team discussion",
+ "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.",
+ "operationId": "reactions/create-for-team-discussion",
+ "tags": [
+ "reactions"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/reactions/#create-reaction-for-a-team-discussion"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types) to add to the team discussion.",
+ "enum": [
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "rocket",
+ "eyes"
+ ]
+ }
+ },
+ "required": [
+ "content"
+ ]
+ },
+ "example": {
+ "content": "heart"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "echo",
+ "note": "The team discussions API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-07-team-discussions-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.echo-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "squirrel-girl",
+ "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions) reactions."
+ }
+ ],
+ "category": "reactions",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "operationId": "teams/list-members",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#list-team-members"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/teams/{team_id}/members/{username}": {
+ "get": {
+ "summary": "Get team member (Legacy)",
+ "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-team-member-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server 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 Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-team-member-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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://docs.github.com/enterprise-server@2.18/rest\""
+ }
+ }
+ },
+ "examples": {
+ "response-if-you-attempt-to-add-an-organization-to-a-team": {
+ "summary": "Response if you attempt to add an organization to a team",
+ "value": {
+ "message": "Cannot add an organization as a member.",
+ "errors": [
+ {
+ "code": "org",
+ "field": "user",
+ "resource": "TeamMember"
+ }
+ ]
+ }
+ },
+ "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": {
+ "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization",
+ "value": {
+ "message": "User isn't a member of this organization. Please invite them first.",
+ "errors": [
+ {
+ "code": "unaffiliated",
+ "field": "user",
+ "resource": "TeamMember"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server 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 Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-member-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#remove-team-member-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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",
+ "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@2.18/rest/reference/teams#create-a-team).",
+ "operationId": "teams/get-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#get-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.",
+ "operationId": "teams/add-or-update-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-or-update-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.",
+ "operationId": "teams/remove-membership-for-user",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#remove-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/teams/{team_id}/projects": {
+ "get": {
+ "summary": "List team projects",
+ "description": "Lists the organization projects for a team. If you are an [authenticated](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#authentication) site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
+ "operationId": "teams/list-projects",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-team-projects"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/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. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
+ "operationId": "teams/check-permissions-for-project",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#check-team-permissions-for-a-project"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Response if project is not managed by this team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "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.",
+ "operationId": "teams/add-or-update-project-permissions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#add-or-update-team-project-permissions"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.inertia-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Response if the project is not owned by the organization",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "response-if-the-project-is-not-owned-by-the-organization": {
+ "value": {
+ "message": "Must have admin rights to Repository.",
+ "documentation_url": "https://docs.github.com/enterprise-server@2.18/rest/reference/teams#add-or-update-team-project-permissions"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "permission": {
+ "type": "string",
+ "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "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. **Note:** This endpoint removes the project from the team, but does not delete it.",
+ "operationId": "teams/remove-project",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#remove-a-project-from-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/repos": {
+ "get": {
+ "summary": "List team repositories",
+ "description": "**Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team.\n\nIf you are an [authenticated](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#authentication) site administrator for your Enterprise instance, you will be able to list all repositories for the team.",
+ "operationId": "teams/list-repos",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-team-repositories"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "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": null,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/repos/{owner}/{repo}": {
+ "get": {
+ "summary": "Check team permissions for a repository",
+ "description": "**Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "operationId": "teams/check-permissions-for-repo",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#check-team-permissions-for-a-repository"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Alternative response with extra repository information",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "application/vnd.github.v3.repository+json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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": [
+ {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ ]
+ },
+ "allow_squash_merge": {
+ "type": "boolean",
+ "example": true
+ },
+ "allow_merge_commit": {
+ "type": "boolean",
+ "example": true
+ },
+ "subscribers_count": {
+ "type": "integer",
+ "example": 42
+ },
+ "network_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "license": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "organization": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "parent": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "source": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "alternative-response-with-extra-repository-information": {
+ "summary": "Alternative response with extra repository information",
+ "value": {
+ "organization": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "parent": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ },
+ "source": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ },
+ "permissions": {
+ "pull": true,
+ "triage": true,
+ "push": false,
+ "maintain": false,
+ "admin": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "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.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "teams/add-or-update-repo-permissions",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#add-or-update-team-repository-permissions"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "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. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ },
+ "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. NOTE: This does not delete the repository, it just removes it from the team.",
+ "operationId": "teams/remove-repo",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#remove-a-repository-from-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/teams/{team_id}/teams": {
+ "get": {
+ "summary": "List child teams",
+ "description": "You must use the `hellcat-preview` media type to use this endpoint.",
+ "operationId": "teams/list-child",
+ "tags": [
+ "teams"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-child-teams"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response if child teams exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "type": "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"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/user": {
+ "get": {
+ "summary": "Get the authenticated user",
+ "description": "If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.\n\nIf the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#get-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "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
+ },
+ "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"
+ ]
+ },
+ {
+ "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
+ },
+ "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
+ }
+ ]
+ },
+ "examples": {
+ "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...",
+ "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
+ }
+ }
+ },
+ "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...",
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2008-01-14T04:33:35Z"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update the authenticated user",
+ "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/update-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "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
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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...",
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": null
+ }
+ }
+ },
+ "/user/emails": {
+ "get": {
+ "summary": "List email addresses for the authenticated user",
+ "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-emails-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-email-addresses-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "email": "octocat@github.com",
+ "verified": true,
+ "primary": true,
+ "visibility": "public"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#add-an-email-address-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "emails": {
+ "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ },
+ "example": [
+
+ ]
+ }
+ },
+ "required": [
+ "emails"
+ ],
+ "example": {
+ "emails": [
+ "octocat@github.com",
+ "mona@github.com"
+ ]
+ }
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "email": "octocat@octocat.org",
+ "primary": false,
+ "verified": false,
+ "visibility": "public"
+ },
+ {
+ "email": "octocat@github.com",
+ "primary": false,
+ "verified": false,
+ "visibility": null
+ },
+ {
+ "email": "mona@github.com",
+ "primary": false,
+ "verified": false,
+ "visibility": null
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "type": "object",
+ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
+ "properties": {
+ "emails": {
+ "description": "Email addresses associated with the GitHub user account.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ },
+ "example": {
+ "emails": [
+ "octocat@github.com",
+ "mona@github.com"
+ ]
+ }
+ }
+ },
+ "required": [
+ "emails"
+ ]
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "username@example.com",
+ "minItems": 1
+ }
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#list-followers-of-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#list-the-people-the-authenticated-user-follows"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/follow",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#follow-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#unfollow-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "GPG Key",
+ "description": "A unique encryption key",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3
+ },
+ "primary_key_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "key_id": {
+ "type": "string",
+ "example": "3262EFF25BA0D270"
+ },
+ "public_key": {
+ "type": "string",
+ "example": "xsBNBFayYZ..."
+ },
+ "emails": {
+ "type": "array",
+ "example": [
+ {
+ "email": "mastahyeti@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "example": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "subkeys": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": null
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "primary_key_id": {
+ "type": "integer"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "public_key": {
+ "type": "string"
+ },
+ "emails": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "can_sign": {
+ "type": "boolean"
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "expires_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "can_sign": {
+ "type": "boolean",
+ "example": true
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean",
+ "example": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-03-24T11:31:04-06:00"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "primary_key_id",
+ "key_id",
+ "raw_key",
+ "public_key",
+ "created_at",
+ "expires_at",
+ "can_sign",
+ "can_encrypt_comms",
+ "can_encrypt_storage",
+ "can_certify",
+ "emails",
+ "subkeys"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "users/create-gpg-key-for-authenticated",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#create-a-gpg-key-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "armored_public_key": {
+ "description": "A GPG key in ASCII-armored format.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "required": [
+ "armored_public_key"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "GPG Key",
+ "description": "A unique encryption key",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3
+ },
+ "primary_key_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "key_id": {
+ "type": "string",
+ "example": "3262EFF25BA0D270"
+ },
+ "public_key": {
+ "type": "string",
+ "example": "xsBNBFayYZ..."
+ },
+ "emails": {
+ "type": "array",
+ "example": [
+ {
+ "email": "mastahyeti@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "example": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "subkeys": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": null
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "primary_key_id": {
+ "type": "integer"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "public_key": {
+ "type": "string"
+ },
+ "emails": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "can_sign": {
+ "type": "boolean"
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "expires_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "can_sign": {
+ "type": "boolean",
+ "example": true
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean",
+ "example": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-03-24T11:31:04-06:00"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "primary_key_id",
+ "key_id",
+ "raw_key",
+ "public_key",
+ "created_at",
+ "expires_at",
+ "can_sign",
+ "can_encrypt_comms",
+ "can_encrypt_storage",
+ "can_certify",
+ "emails",
+ "subkeys"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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-----\""
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-gpg-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "GPG Key",
+ "description": "A unique encryption key",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3
+ },
+ "primary_key_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "key_id": {
+ "type": "string",
+ "example": "3262EFF25BA0D270"
+ },
+ "public_key": {
+ "type": "string",
+ "example": "xsBNBFayYZ..."
+ },
+ "emails": {
+ "type": "array",
+ "example": [
+ {
+ "email": "mastahyeti@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "example": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "subkeys": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": null
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "primary_key_id": {
+ "type": "integer"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "public_key": {
+ "type": "string"
+ },
+ "emails": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "can_sign": {
+ "type": "boolean"
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "expires_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "can_sign": {
+ "type": "boolean",
+ "example": true
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean",
+ "example": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-03-24T11:31:04-06:00"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "primary_key_id",
+ "key_id",
+ "raw_key",
+ "public_key",
+ "created_at",
+ "expires_at",
+ "can_sign",
+ "can_encrypt_comms",
+ "can_encrypt_storage",
+ "can_certify",
+ "emails",
+ "subkeys"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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-----\""
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-gpg-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "gpg_key_id",
+ "description": "gpg_key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "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": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "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.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installation-repos-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#list-repositories-accessible-to-the-user-access-token"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 1,
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ },
+ {
+ "required": false,
+ "name": "mercy",
+ "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```"
+ }
+ ],
+ "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.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/add-repo-to-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#add-a-repository-to-an-app-installation"
+ },
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "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.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.18/rest/reference/oauth-authorizations#create-a-new-authorization) or [Basic Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/other-authentication-methods#basic-authentication) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/remove-repo-from-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#remove-a-repository-from-an-app-installation"
+ },
+ "parameters": [
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repository_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "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.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "tags": [
+ "issues"
+ ],
+ "operationId": "issues/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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"
+ }
+ },
+ {
+ "name": "labels",
+ "description": "A list of comma separated label names. Example: `bug,ui,@high`",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "body_html": {
+ "type": "string"
+ },
+ "body_text": {
+ "type": "string"
+ },
+ "timeline_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "author_association": {
+ "type": "string"
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "node_id": "MDU6SXNzdWUx",
+ "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+ "repository_url": "https://api.github.com/repos/octocat/Hello-World",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
+ "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+ "number": 1347,
+ "state": "open",
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "labels": [
+ {
+ "id": 208045946,
+ "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+ "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513",
+ "default": true
+ }
+ ],
+ "assignee": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "assignees": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "milestone": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+ "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
+ "id": 1002604,
+ "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
+ "number": 1,
+ "state": "open",
+ "title": "v1.0",
+ "description": "Tracking milestone for version 1.0",
+ "creator": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "open_issues": 4,
+ "closed_issues": 8,
+ "created_at": "2011-04-10T20:09:31Z",
+ "updated_at": "2014-03-03T18:58:10Z",
+ "closed_at": "2013-02-12T13:22:01Z",
+ "due_on": "2012-10-09T23:39:01Z"
+ },
+ "locked": true,
+ "active_lock_reason": "too heated",
+ "comments": 0,
+ "pull_request": {
+ "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
+ "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+ "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+ "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+ },
+ "closed_at": null,
+ "created_at": "2011-04-22T13:33:48Z",
+ "updated_at": "2011-04-22T13:33:48Z",
+ "repository": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "machine-man",
+ "note": "If an issue event is created via a GitHub App, the response will include the `performed_via_github_app` object with\tinformation about the GitHub App. For more information, see the [related blog\tpost](https://developer.github.com/changes/2016-09-14-Integrations-Early-Access).\nTo receive the `performed_via_github_app` object in the response, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.machine-man-preview\n```"
+ }
+ ],
+ "category": "issues"
+ }
+ }
+ },
+ "/user/keys": {
+ "get": {
+ "summary": "List public SSH keys for the authenticated user",
+ "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "operationId": "users/create-public-ssh-key-for-authenticated",
+ "tags": [
+ "users"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "A descriptive name for the new key.",
+ "type": "string",
+ "example": "Personal MacBook Air"
+ },
+ "key": {
+ "description": "The public SSH key to add to your GitHub account.",
+ "type": "string",
+ "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-public-ssh-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "key_id",
+ "description": "key_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": "keys"
+ }
+ }
+ },
+ "/user/memberships/orgs": {
+ "get": {
+ "summary": "List organization memberships for the authenticated user",
+ "description": "",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-memberships-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "state",
+ "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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"
+ ]
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "can_create_repository": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "can_create_repository"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "role",
+ "organization_url",
+ "url",
+ "organization",
+ "user"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": {
+ "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"
+ ]
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "can_create_repository": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "can_create_repository"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "role",
+ "organization_url",
+ "url",
+ "organization",
+ "user"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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"
+ ]
+ },
+ "user": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "can_create_repository": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "can_create_repository"
+ ]
+ }
+ },
+ "required": [
+ "state",
+ "role",
+ "organization_url",
+ "url",
+ "organization",
+ "user"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/user/orgs": {
+ "get": {
+ "summary": "List organizations for the authenticated user",
+ "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#list-organizations-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": null
+ }
+ }
+ },
+ "/user/projects": {
+ "post": {
+ "summary": "Create a user project",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ }
+ },
+ "/user/public_emails": {
+ "get": {
+ "summary": "List public email addresses for the authenticated user",
+ "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-emails-for-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "email": "octocat@github.com",
+ "verified": true,
+ "primary": true,
+ "visibility": "public"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Default response",
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "418": {
+ "description": "Response definition missing"
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create a repository for the authenticated user",
+ "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/create-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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",
+ "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,
+ "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,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/repos/octocat/Hello-World",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
+ },
+ {
+ "required": false,
+ "name": "baptiste",
+ "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@2.18/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/user/repository_invitations": {
+ "get": {
+ "summary": "List repository invitations for the authenticated user",
+ "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.",
+ "tags": [
+ "repos"
+ ],
+ "operationId": "repos/list-invitations-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#list-repository-invitations-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "invitee": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "inviter": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#accept-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/reference/repos#decline-a-repository-invitation"
+ },
+ "parameters": [
+ {
+ "name": "invitation_id",
+ "description": "invitation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "409": {
+ "description": "Conflict",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-starred-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default-response": {
+ "summary": "Default response",
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ },
+ "application/vnd.github.v3.star+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Starred Repository",
+ "description": "Starred Repository",
+ "type": "object",
+ "properties": {
+ "starred_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "starred_at",
+ "repo"
+ ]
+ }
+ },
+ "examples": {
+ "alternative-response-with-star-creation-timestamps": {
+ "summary": "Alternative response with star creation timestamps",
+ "value": [
+ {
+ "starred_at": "2011-01-16T19:06:43Z",
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/star-repo-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#star-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#unstar-a-repository-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-watched-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "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": null,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/teams/#list-teams-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "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_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"
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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": null,
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "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"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "teams",
+ "subcategory": null
+ }
+ }
+ },
+ "/users": {
+ "get": {
+ "summary": "List users",
+ "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#list-users"
+ },
+ "parameters": [
+ {
+ "name": "since",
+ "description": "A user ID. Only return users with an ID greater than this ID.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}": {
+ "get": {
+ "summary": "Get a user",
+ "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@2.18/rest/reference/users#emails)\".",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-by-username",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#get-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "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
+ },
+ "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"
+ ]
+ },
+ {
+ "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
+ },
+ "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
+ }
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ },
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}/events": {
+ "get": {
+ "summary": "List events for the authenticated user",
+ "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-events-for-authenticated-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-events-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-organization-events-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-events-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#list-followers-of-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#list-the-people-a-user-follows"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/users#check-if-a-user-follows-another-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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://docs.github.com/enterprise-server@2.18/v3/gists/#list-gists-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}/gpg_keys": {
+ "get": {
+ "summary": "List GPG keys for a user",
+ "description": "Lists the GPG keys for a user. This information is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-gpg-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-gpg-keys-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "GPG Key",
+ "description": "A unique encryption key",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "example": 3
+ },
+ "primary_key_id": {
+ "type": "integer",
+ "nullable": true
+ },
+ "key_id": {
+ "type": "string",
+ "example": "3262EFF25BA0D270"
+ },
+ "public_key": {
+ "type": "string",
+ "example": "xsBNBFayYZ..."
+ },
+ "emails": {
+ "type": "array",
+ "example": [
+ {
+ "email": "mastahyeti@users.noreply.github.com",
+ "verified": true
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "verified": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "example": [
+ {
+ "id": 4,
+ "primary_key_id": 3,
+ "key_id": "4A595D4C72EE49C7",
+ "public_key": "zsBNBFayYZ...",
+ "emails": [
+
+ ],
+ "subkeys": [
+
+ ],
+ "can_sign": false,
+ "can_encrypt_comms": true,
+ "can_encrypt_storage": true,
+ "can_certify": false,
+ "created_at": "2016-03-24T11:31:04-06:00",
+ "expires_at": null
+ }
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "primary_key_id": {
+ "type": "integer"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "public_key": {
+ "type": "string"
+ },
+ "emails": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "subkeys": {
+ "type": "array",
+ "items": {
+ }
+ },
+ "can_sign": {
+ "type": "boolean"
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "expires_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "can_sign": {
+ "type": "boolean",
+ "example": true
+ },
+ "can_encrypt_comms": {
+ "type": "boolean"
+ },
+ "can_encrypt_storage": {
+ "type": "boolean"
+ },
+ "can_certify": {
+ "type": "boolean",
+ "example": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2016-03-24T11:31:04-06:00"
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "raw_key": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "primary_key_id",
+ "key_id",
+ "raw_key",
+ "public_key",
+ "created_at",
+ "expires_at",
+ "can_sign",
+ "can_encrypt_comms",
+ "can_encrypt_storage",
+ "can_certify",
+ "emails",
+ "subkeys"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/get-context-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/users/#get-contextual-information-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "contexts": [
+ {
+ "message": "Owns this repository",
+ "octicon": "repo"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "users",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}/installation": {
+ "get": {
+ "summary": "Get a user installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-user-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/apps/#get-a-user-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "account": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "avatar_url": "https://github.com/images/error/hubot_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/orgs/github",
+ "html_url": "https://github.com/github",
+ "followers_url": "https://api.github.com/users/github/followers",
+ "following_url": "https://api.github.com/users/github/following{/other_user}",
+ "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+ "organizations_url": "https://api.github.com/users/github/orgs",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "received_events_url": "https://api.github.com/users/github/received_events",
+ "type": "Organization",
+ "site_admin": false
+ },
+ "repository_selection": "all",
+ "access_tokens_url": "https://api.github.com/installations/1/access_tokens",
+ "repositories_url": "https://api.github.com/installation/repositories",
+ "html_url": "https://github.com/organizations/github/settings/installations/1",
+ "app_id": 1,
+ "target_id": 1,
+ "target_type": "Organization",
+ "permissions": {
+ "checks": "write",
+ "metadata": "read",
+ "contents": "read"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "created_at": "2018-02-09T20:51:14Z",
+ "updated_at": "2018-02-09T20:51:14Z",
+ "single_file_name": "config.yml",
+ "app_slug": "github-actions"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/users/{username}/keys": {
+ "get": {
+ "summary": "List public keys for a user",
+ "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.",
+ "tags": [
+ "users"
+ ],
+ "operationId": "users/list-public-keys-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/users#list-public-keys-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Key Simple",
+ "description": "Key Simple",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "id"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "key": "ssh-rsa AAA..."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.",
+ "tags": [
+ "orgs"
+ ],
+ "operationId": "orgs/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/orgs/#list-organizations-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "orgs",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}/projects": {
+ "get": {
+ "summary": "List user projects",
+ "description": "",
+ "tags": [
+ "projects"
+ ],
+ "operationId": "projects/list-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/v3/projects/#list-user-projects"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "inertia",
+ "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```"
+ }
+ ],
+ "category": "projects",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}/received_events": {
+ "get": {
+ "summary": "List events received by the authenticated user",
+ "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-received-events-for-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-events-received-by-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-public-events-received-by-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDExOkludGVncmF0aW9uMQ=="
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/v3/repos/#list-repositories-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ ]
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "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": null,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": false,
+ "name": "nebula",
+ "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@2.18/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
+ }
+ ],
+ "category": "repos",
+ "subcategory": null
+ }
+ }
+ },
+ "/users/{username}/site_admin": {
+ "put": {
+ "summary": "Promote a user to be a site administrator",
+ "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "enterprise-admin/promote-user-to-be-site-administrator",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#promote-a-user-to-be-a-site-administrator"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Demote a site administrator",
+ "description": "You can demote any user account except your own.",
+ "operationId": "enterprise-admin/demote-site-administrator",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#demote-a-site-administrator"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/users/{username}/starred": {
+ "get": {
+ "summary": "List repositories starred by a user",
+ "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types/) via the `Accept` header:",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-repos-starred-by-user",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-starred-by-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "One of `asc` (ascending) or `desc` (descending).",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default-response": {
+ "summary": "Default response",
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ },
+ "application/vnd.github.v3.star+json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Starred Repository",
+ "description": "Starred Repository",
+ "type": "object",
+ "properties": {
+ "starred_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "repo": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "starred_at",
+ "repo"
+ ]
+ }
+ },
+ "examples": {
+ "alternative-response-with-star-creation-timestamps": {
+ "summary": "Alternative response with star creation timestamps",
+ "value": [
+ {
+ "starred_at": "2011-01-16T19:06:43Z",
+ "repo": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.18/rest/reference/activity#list-repositories-watched-by-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "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": null,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "spdx_id": "MIT",
+ "url": "https://api.github.com/licenses/mit",
+ "node_id": "MDc6TGljZW5zZW1pdA=="
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "activity",
+ "subcategory": "watching"
+ }
+ }
+ },
+ "/users/{username}/suspended": {
+ "put": {
+ "summary": "Suspend a user",
+ "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#http-verbs).\"",
+ "operationId": "enterprise-admin/suspend-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#suspend-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action."
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Unsuspend a user",
+ "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.",
+ "operationId": "enterprise-admin/unsuspend-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/enterprise-admin#unsuspend-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action."
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json
new file mode 100644
index 000000000000..420172c645b7
--- /dev/null
+++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json
@@ -0,0 +1,251070 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "version": "1.1.4",
+ "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": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname",
+ "default": "HOSTNAME"
+ },
+ "protocol": {
+ "description": "Self-hosted Enterprise Server or Enterprise Cloud protocol",
+ "default": "http"
+ }
+ }
+ }
+ ],
+ "externalDocs": {
+ "description": "GitHub Enterprise Developer Docs",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/"
+ },
+ "paths": {
+ "/": {
+ "get": {
+ "summary": "GitHub API Root",
+ "description": "Get Hypermedia links to resources accessible in GitHub's REST API",
+ "tags": [
+ "meta"
+ ],
+ "operationId": "meta/root",
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "current_user_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "current_user_authorizations_html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "authorizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "code_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "commit_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "emails_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "emojis_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "feeds_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "following_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gists_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "hub_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "issue_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "issues_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "keys_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "label_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "notifications_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organization_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organization_repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organization_teams_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "public_gists_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "rate_limit_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repository_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "current_user_repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "starred_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "starred_gists_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "topic_search_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "user_search_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "current_user_url",
+ "current_user_authorizations_html_url",
+ "authorizations_url",
+ "code_search_url",
+ "commit_search_url",
+ "emails_url",
+ "emojis_url",
+ "events_url",
+ "feeds_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "hub_url",
+ "issue_search_url",
+ "issues_url",
+ "keys_url",
+ "label_search_url",
+ "notifications_url",
+ "organization_url",
+ "organization_repositories_url",
+ "organization_teams_url",
+ "public_gists_url",
+ "rate_limit_url",
+ "repository_url",
+ "repository_search_url",
+ "current_user_repositories_url",
+ "starred_url",
+ "starred_gists_url",
+ "user_url",
+ "user_organizations_url",
+ "user_repositories_url",
+ "user_search_url"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "meta"
+ }
+ }
+ },
+ "/admin/hooks": {
+ "get": {
+ "summary": "List global webhooks",
+ "description": "",
+ "operationId": "enterprise-admin/list-global-webhooks",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-global-webhooks"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ },
+ "post": {
+ "summary": "Create a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/create-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.",
+ "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://docs.github.com/enterprise-server@2.19/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": "The [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "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",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ }
+ },
+ "/admin/hooks/{hook_id}": {
+ "get": {
+ "summary": "Get a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/get-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "json",
+ "insecure_ssl": "0",
+ "secret": "********"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a global webhook",
+ "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.",
+ "operationId": "enterprise-admin/update-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "content_type": {
+ "type": "string"
+ },
+ "insecure_ssl": {
+ "type": "string"
+ }
+ }
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "ping_url": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "type": "Global",
+ "id": 1,
+ "name": "web",
+ "active": true,
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com",
+ "content_type": "form",
+ "insecure_ssl": "0"
+ },
+ "updated_at": "2017-12-07T00:14:59Z",
+ "created_at": "2017-12-07T00:14:59Z",
+ "url": "https://api.github.com/admin/hooks/1",
+ "ping_url": "https://api.github.com/admin/hooks/1/pings"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "object",
+ "description": "Key/value pairs to provide settings for this webhook.",
+ "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://docs.github.com/enterprise-server@2.19/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": "The [events](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
+ "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": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete a global webhook",
+ "description": "",
+ "operationId": "enterprise-admin/delete-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ }
+ },
+ "/admin/hooks/{hook_id}/pings": {
+ "post": {
+ "summary": "Ping a global webhook",
+ "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@2.19/webhooks/#ping-event) to be sent to the webhook.",
+ "operationId": "enterprise-admin/ping-global-webhook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#ping-a-global-webhook"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.superpro-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "superpro",
+ "note": "The [Global Webhooks API](https://docs.github.com/enterprise-server@2.19/enterprise/rest/reference/enterprise-admin#global-webhooks) is currently available for developers to preview. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.superpro-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "global-webhooks"
+ }
+ }
+ },
+ "/admin/keys": {
+ "get": {
+ "summary": "List public keys",
+ "description": "",
+ "operationId": "enterprise-admin/list-public-keys",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-public-keys"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "key_id": {
+ "type": "string"
+ },
+ "key": {
+ "type": "string"
+ },
+ "user_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "repository_id": {
+ "nullable": true,
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "user_id": 232,
+ "repository_id": null
+ },
+ {
+ "key_id": "012345678912345678",
+ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
+ "user_id": null,
+ "repository_id": 2333,
+ "id": "2",
+ "url": "https://api.github.com/repos/octocat/Hello-World/keys/2"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/keys/{key_ids}": {
+ "delete": {
+ "summary": "Delete a public key",
+ "description": "",
+ "operationId": "enterprise-admin/delete-public-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-public-key"
+ },
+ "parameters": [
+ {
+ "name": "key_ids",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/ldap/teams/{team_id}/mapping": {
+ "patch": {
+ "summary": "Update LDAP mapping for a team",
+ "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@2.19/v3/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.",
+ "operationId": "enterprise-admin/update-ldap-mapping-for-team",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string"
+ },
+ "parent": {
+ "nullable": true
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com",
+ "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": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."
+ }
+ }
+ },
+ "example": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": false,
+ "name": "hellcat",
+ "note": "The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.hellcat-preview+json\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/ldap/teams/{team_id}/sync": {
+ "post": {
+ "summary": "Sync LDAP mapping for a team",
+ "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
+ "operationId": "enterprise-admin/sync-ldap-mapping-for-team",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-team"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "status": "queued"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/ldap/users/{username}/mapping": {
+ "patch": {
+ "summary": "Update LDAP mapping for a user",
+ "description": "",
+ "operationId": "enterprise-admin/update-ldap-mapping-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com",
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team."
+ }
+ }
+ },
+ "example": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/ldap/users/{username}/sync": {
+ "post": {
+ "summary": "Sync LDAP mapping for a user",
+ "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
+ "operationId": "enterprise-admin/sync-ldap-mapping-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "status": "queued"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "ldap"
+ }
+ }
+ },
+ "/admin/organizations": {
+ "post": {
+ "summary": "Create an organization",
+ "description": "",
+ "operationId": "enterprise-admin/create-org",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-an-organization"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The organization's username."
+ },
+ "admin": {
+ "type": "string",
+ "description": "The login of the user who will manage this organization."
+ },
+ "profile_name": {
+ "type": "string",
+ "description": "The organization's display name."
+ }
+ },
+ "required": [
+ "login",
+ "admin"
+ ]
+ },
+ "example": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/admin/organizations/{org}": {
+ "patch": {
+ "summary": "Update an organization name",
+ "description": "",
+ "operationId": "enterprise-admin/update-org-name",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-an-organization-name"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "message": "Job queued to rename organization. It may take a few minutes to complete.",
+ "url": "https:///api/v3/organizations/1"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The organization's new name."
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "the-new-octocats"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "orgs"
+ }
+ }
+ },
+ "/admin/pre-receive-environments": {
+ "get": {
+ "summary": "List pre-receive environments",
+ "description": "",
+ "operationId": "enterprise-admin/list-pre-receive-environments",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-pre-receive-environments"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "name": "Default",
+ "image_url": "githubenterprise://internal",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/1",
+ "default_environment": true,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 14,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
+ "state": "not_started",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ },
+ "post": {
+ "summary": "Create a pre-receive environment",
+ "description": "",
+ "operationId": "enterprise-admin/create-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-pre-receive-environment"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "not_started",
+ "downloaded_at": null,
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The new pre-receive environment's name."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment."
+ }
+ },
+ "required": [
+ "name",
+ "image_url"
+ ]
+ },
+ "example": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-environments/{pre_receive_environment_id}": {
+ "get": {
+ "summary": "Get a pre-receive environment",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ },
+ "patch": {
+ "summary": "Update a pre-receive environment",
+ "description": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.",
+ "operationId": "enterprise-admin/update-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default-response": {
+ "value": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Client Errors",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "client-errors": {
+ "value": {
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "PreReceiveEnvironment",
+ "code": "custom",
+ "message": "Cannot modify or delete the default environment"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "This pre-receive environment's new name."
+ },
+ "image_url": {
+ "type": "string",
+ "description": "URL from which to download a tarball of this environment."
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ },
+ "delete": {
+ "summary": "Delete a pre-receive environment",
+ "description": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_",
+ "operationId": "enterprise-admin/delete-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "422": {
+ "description": "Client Errors",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "client-errors": {
+ "value": {
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "PreReceiveEnvironment",
+ "code": "custom",
+ "message": "Cannot modify or delete the default environment"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": {
+ "post": {
+ "summary": "Start a pre-receive environment download",
+ "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_",
+ "operationId": "enterprise-admin/start-pre-receive-environment-download",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#start-a-pre-receive-environment-download"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default-response": {
+ "value": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest",
+ "state": "not_started",
+ "downloaded_at": null,
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Client Errors",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "client-errors": {
+ "value": {
+ "message": "Validation Failed",
+ "errors": [
+ {
+ "resource": "PreReceiveEnvironment",
+ "code": "custom",
+ "message": "Can not start a new download when a download is in progress"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": {
+ "get": {
+ "summary": "Get the download status for a pre-receive environment",
+ "description": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.",
+ "operationId": "enterprise-admin/get-download-status-for-pre-receive-environment",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_environment_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-environments"
+ }
+ }
+ },
+ "/admin/pre-receive-hooks": {
+ "get": {
+ "summary": "List pre-receive hooks",
+ "description": "",
+ "operationId": "enterprise-admin/list-pre-receive-hooks",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-pre-receive-hooks"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ },
+ "post": {
+ "summary": "Create a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/create-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-pre-receive-hook"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the hook."
+ },
+ "script": {
+ "type": "string",
+ "description": "The script that the hook runs."
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "environment": {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook. default: `disabled`"
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level. default: `false`"
+ }
+ },
+ "required": [
+ "name",
+ "script",
+ "script_repository",
+ "environment"
+ ]
+ },
+ "example": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ }
+ },
+ "/admin/pre-receive-hooks/{pre_receive_hook_id}": {
+ "get": {
+ "summary": "Get a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/get-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-a-pre-receive-hook"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 2,
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/2",
+ "default_environment": false,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ },
+ "patch": {
+ "summary": "Update a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/update-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-a-pre-receive-hook"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "enforcement": {
+ "type": "string"
+ },
+ "script": {
+ "type": "string"
+ },
+ "script_repository": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "full_name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ }
+ }
+ },
+ "environment": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "image_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "default_environment": {
+ "type": "boolean"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "hooks_count": {
+ "type": "integer"
+ },
+ "download": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "downloaded_at": {
+ "nullable": true,
+ "type": "string"
+ },
+ "message": {
+ "nullable": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 1,
+ "name": "Check Commits",
+ "enforcement": "disabled",
+ "script": "scripts/commmit_check.sh",
+ "script_repository": {
+ "id": 595,
+ "full_name": "DevIT/hooks",
+ "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
+ "html_url": "https://github.example.com/DevIT/hooks"
+ },
+ "environment": {
+ "id": 1,
+ "name": "Default",
+ "image_url": "githubenterprise://internal",
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
+ "html_url": "https://github.example.com/admin/pre-receive-environments/1",
+ "default_environment": true,
+ "created_at": "2016-05-20T11:35:45-05:00",
+ "hooks_count": 1,
+ "download": {
+ "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
+ "state": "success",
+ "downloaded_at": "2016-05-26T07:42:53-05:00",
+ "message": null
+ }
+ },
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the hook."
+ },
+ "script": {
+ "type": "string",
+ "description": "The script that the hook runs."
+ },
+ "script_repository": {
+ "type": "object",
+ "description": "The GitHub repository where the script is kept.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "environment": {
+ "type": "object",
+ "description": "The pre-receive environment where the script is executed.",
+ "properties": {
+ },
+ "additionalProperties": true
+ },
+ "enforcement": {
+ "type": "string",
+ "description": "The state of enforcement for this hook."
+ },
+ "allow_downstream_configuration": {
+ "type": "boolean",
+ "description": "Whether enforcement can be overridden at the org or repo level."
+ }
+ }
+ },
+ "example": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ },
+ "delete": {
+ "summary": "Delete a pre-receive hook",
+ "description": "",
+ "operationId": "enterprise-admin/delete-pre-receive-hook",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-pre-receive-hook"
+ },
+ "parameters": [
+ {
+ "name": "pre_receive_hook_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "eye-scream",
+ "note": "APIs for managing pre-receive hooks are currently available for developers to preview. During the preview period, the APIs may change without advance notice.\n\nTo access the API you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.eye-scream-preview\n```"
+ }
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "pre-receive-hooks"
+ }
+ }
+ },
+ "/admin/tokens": {
+ "get": {
+ "summary": "List personal access tokens",
+ "description": "Lists personal access tokens for all users, including admin users.",
+ "operationId": "enterprise-admin/list-personal-access-tokens",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#list-personal-access-tokens"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 2,
+ "url": "https://enterprise.octocat.com/api/v3/authorizations/2",
+ "app": {
+ "name": "My personal access token",
+ "url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
+ "client_id": "00000000000000000000"
+ },
+ "token": "",
+ "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45",
+ "token_last_eight": "848f9f8a",
+ "note": "My personal access token",
+ "note_url": null,
+ "created_at": "2019-04-24T21:49:02Z",
+ "updated_at": "2019-04-24T21:49:02Z",
+ "scopes": [
+ "admin:business",
+ "admin:gpg_key",
+ "admin:org",
+ "admin:org_hook",
+ "admin:pre_receive_hook",
+ "admin:public_key",
+ "admin:repo_hook",
+ "delete_repo",
+ "gist",
+ "notifications",
+ "repo",
+ "user",
+ "write:discussion"
+ ],
+ "fingerprint": null
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/tokens/{token_id}": {
+ "delete": {
+ "summary": "Delete a personal access token",
+ "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.",
+ "operationId": "enterprise-admin/delete-personal-access-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-personal-access-token"
+ },
+ "parameters": [
+ {
+ "name": "token_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/users": {
+ "post": {
+ "summary": "Create a user",
+ "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.",
+ "operationId": "enterprise-admin/create-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-a-user"
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The user's username."
+ },
+ "email": {
+ "type": "string",
+ "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://help.github.com/enterprise/2.19/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)."
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/users/{username}": {
+ "patch": {
+ "summary": "Update the username for a user",
+ "description": "",
+ "operationId": "enterprise-admin/update-username-for-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#update-the-username-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "message": "Job queued to rename user. It may take a few minutes to complete.",
+ "url": "https://api.github.com/user/1"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The user's new username."
+ }
+ },
+ "required": [
+ "login"
+ ]
+ },
+ "example": {
+ "login": "thenewmonalisa"
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Delete a user",
+ "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.",
+ "operationId": "enterprise-admin/delete-user",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-a-user"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/admin/users/{username}/authorizations": {
+ "post": {
+ "summary": "Create an impersonation OAuth token",
+ "description": "",
+ "operationId": "enterprise-admin/create-impersonation-o-auth-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#create-an-impersonation-oauth-token"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "type": "array",
+ "description": "A list of [scopes](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ },
+ "delete": {
+ "summary": "Delete an impersonation OAuth token",
+ "description": "",
+ "operationId": "enterprise-admin/delete-impersonation-o-auth-token",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token"
+ },
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "users"
+ }
+ }
+ },
+ "/app": {
+ "get": {
+ "summary": "Get the authenticated app",
+ "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@2.19/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-authenticated",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-the-authenticated-app"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ },
+ "examples": {
+ "default": {
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/app-manifests/{code}/conversions": {
+ "post": {
+ "summary": "Create a GitHub App from a manifest",
+ "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-from-manifest",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/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": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ },
+ {
+ "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": {
+ "value": {
+ "id": 1,
+ "slug": "octoapp",
+ "node_id": "MDxOkludGVncmF0aW9uMQ==",
+ "owner": {
+ "login": "github",
+ "id": 1,
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": true
+ },
+ "name": "Octocat App",
+ "description": "",
+ "external_url": "https://example.com",
+ "html_url": "https://github.com/apps/octoapp",
+ "created_at": "2017-07-08T16:18:44-04:00",
+ "updated_at": "2017-07-08T16:18:44-04:00",
+ "permissions": {
+ "metadata": "read",
+ "contents": "read",
+ "issues": "write",
+ "single_file": "write"
+ },
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "client_id": "Iv1.8a61f9b3a7aba766",
+ "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8",
+ "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa",
+ "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "apps",
+ "subcategory": null
+ }
+ }
+ },
+ "/app/installations": {
+ "get": {
+ "summary": "List installations for the authenticated app",
+ "description": "You must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/list-installations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#list-installations-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The permissions the installation has are included under the `permissions` key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}": {
+ "get": {
+ "summary": "Get an installation for the authenticated app",
+ "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-an-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Installation",
+ "description": "Installation",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the installation.",
+ "type": "integer",
+ "example": 1
+ },
+ "account": {
+ "nullable": true,
+ "anyOf": [
+ {
+ "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
+ },
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ },
+ "delete": {
+ "summary": "Delete an installation for the authenticated app",
+ "description": "Uninstalls a GitHub App on a user, organization, or business account. You must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/delete-installation",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#delete-an-installation-for-the-authenticated-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+ {
+ "required": true,
+ "name": "gambit",
+ "note": "Uninstalling GitHub Apps and revoking an app's installation token are currently available for developers to preview. To access the new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.gambit-preview+json\n```"
+ },
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/app/installations/{installation_id}/access_tokens": {
+ "post": {
+ "summary": "Create an installation access token for an app",
+ "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-installation-access-token",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#create-an-installation-access-token-for-an-app"
+ },
+ "parameters": [
+ {
+ "name": "accept",
+ "description": "This API is under preview and subject to change.",
+ "in": "header",
+ "schema": {
+ "type": "string",
+ "default": "application/vnd.github.machine-man-preview+json"
+ },
+ "required": true
+ },
+ {
+ "name": "installation_id",
+ "description": "installation_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ }
+ },
+ "single_file": {
+ "type": "string",
+ "example": "README.md"
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "token": "v1.1f699f1069f60xxx",
+ "expires_at": "2016-07-11T22:14:10Z",
+ "permissions": {
+ "issues": "write",
+ "contents": "read"
+ },
+ "repository_selection": "selected",
+ "repositories": [
+ {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": true,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
+ "permissions": {
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "allow_rebase_merge": true,
+ "template_repository": null,
+ "allow_squash_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "anonymous_access_enabled": false
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/applications/grants": {
+ "get": {
+ "summary": "List your grants",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/list-grants",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#list-your-grants"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "scopes",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/applications/grants/{grant_id}": {
+ "get": {
+ "summary": "Get a single grant",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-grant",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-a-single-grant"
+ },
+ "parameters": [
+ {
+ "name": "grant_id",
+ "description": "grant_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "scopes",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete a grant",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/delete-grant",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#delete-a-grant"
+ },
+ "parameters": [
+ {
+ "name": "grant_id",
+ "description": "grant_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/applications/{client_id}/grants/{access_token}": {
+ "delete": {
+ "summary": "Revoke a grant for an application",
+ "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
+ "operationId": "oauth-authorizations/revoke-grant-for-application",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#revoke-a-grant-for-an-application"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ }
+ },
+ "/applications/{client_id}/tokens/{access_token}": {
+ "get": {
+ "summary": "Check an authorization",
+ "description": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "operationId": "oauth-authorizations/check-authorization",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#check-an-authorization"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "scopes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "token": {
+ "type": "string"
+ },
+ "token_last_eight": {
+ "type": "string"
+ },
+ "hashed_token": {
+ "type": "string"
+ },
+ "app": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "client_id": {
+ "type": "string"
+ }
+ }
+ },
+ "note": {
+ "type": "string"
+ },
+ "note_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Reset an authorization",
+ "description": "OAuth applications can use this API method to reset a valid OAuth token without end user involvement. Applications must save the \"token\" property in the response, because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
+ "operationId": "oauth-authorizations/reset-authorization",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#reset-an-authorization"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "url": {
+ "type": "string"
+ },
+ "scopes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "token": {
+ "type": "string"
+ },
+ "token_last_eight": {
+ "type": "string"
+ },
+ "hashed_token": {
+ "type": "string"
+ },
+ "app": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "client_id": {
+ "type": "string"
+ }
+ }
+ },
+ "note": {
+ "type": "string"
+ },
+ "note_url": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string"
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "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"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "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
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Revoke an authorization for an application",
+ "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`.",
+ "operationId": "oauth-authorizations/revoke-authorization-for-application",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#revoke-an-authorization-for-an-application"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "access_token",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "oauth-authorizations",
+ "subcategory": null
+ }
+ }
+ },
+ "/apps/{app_slug}": {
+ "get": {
+ "summary": "Get an app",
+ "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/get-by-slug",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/apps/#get-an-app"
+ },
+ "parameters": [
+ {
+ "name": "app_slug",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ },
+ "examples": {
+ "default": {
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "machine-man",
+ "note": "To access the API with your GitHub App, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` Header for your requests. ```shell application/vnd.github.machine-man-preview+json ```"
+ }
+ ],
+ "category": "apps"
+ }
+ }
+ },
+ "/authorizations": {
+ "get": {
+ "summary": "List your authorizations",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/list-authorizations",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#list-your-authorizations"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 2,
+ "url": "https://enterprise.octocat.com/api/v3/authorizations/2",
+ "app": {
+ "name": "My personal access token",
+ "url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
+ "client_id": "00000000000000000000"
+ },
+ "token": "",
+ "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45",
+ "token_last_eight": "848f9f8a",
+ "note": "My personal access token",
+ "note_url": null,
+ "created_at": "2019-04-24T21:49:02Z",
+ "updated_at": "2019-04-24T21:49:02Z",
+ "scopes": [
+ "admin:business",
+ "admin:gpg_key",
+ "admin:org",
+ "admin:org_hook",
+ "admin:pre_receive_hook",
+ "admin:public_key",
+ "admin:repo_hook",
+ "delete_repo",
+ "gist",
+ "notifications",
+ "repo",
+ "user",
+ "write:discussion"
+ ],
+ "fingerprint": null
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "post": {
+ "summary": "Create a new authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/create-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#create-a-new-authorization"
+ },
+ "parameters": [
+
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "scopes": {
+ "description": "A list of scopes that this authorization is in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "public_repo",
+ "user"
+ ],
+ "nullable": true
+ },
+ "note": {
+ "description": "A note to remind you what the OAuth token is for.",
+ "type": "string",
+ "example": "Update all gems"
+ },
+ "note_url": {
+ "description": "A URL to remind you what app the OAuth token is for.",
+ "type": "string"
+ },
+ "client_id": {
+ "description": "The OAuth app client key for which to create the token.",
+ "maxLength": 20,
+ "type": "string"
+ },
+ "client_secret": {
+ "description": "The OAuth app client secret for which to create the token.",
+ "maxLength": 40,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "A unique string to distinguish an authorization from others created for the same client ID and user.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/authorizations/clients/{client_id}": {
+ "put": {
+ "summary": "Get-or-create an authorization for a specific app",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-or-create-authorization-for-app",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "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"
+ },
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "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": ""
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/authorizations/clients/{client_id}/{fingerprint}": {
+ "put": {
+ "summary": "Get-or-create an authorization for a specific app and fingerprint",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint"
+ },
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Response if returning a new token",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/authorizations/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ }
+ },
+ "/authorizations/{authorization_id}": {
+ "get": {
+ "summary": "Get a single authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/get-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#get-a-single-authorization"
+ },
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update an existing authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/update-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#update-an-existing-authorization"
+ },
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "installation": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ },
+ "has_multiple_single_files": {
+ "type": "boolean",
+ "example": true
+ },
+ "single_file_paths": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": [
+ "config.yml",
+ ".github/issue_TEMPLATE.md"
+ ]
+ }
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "account": {
+ "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
+ }
+ },
+ "required": [
+ "permissions",
+ "repository_selection",
+ "single_file_name",
+ "repositories_url",
+ "account"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "app",
+ "id",
+ "note",
+ "note_url",
+ "scopes",
+ "token",
+ "hashed_token",
+ "token_last_eight",
+ "fingerprint",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "deprecated": true
+ },
+ "delete": {
+ "summary": "Delete an authorization",
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).",
+ "tags": [
+ "oauth-authorizations"
+ ],
+ "operationId": "oauth-authorizations/delete-authorization",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/oauth-authorizations#delete-an-authorization"
+ },
+ "parameters": [
+ {
+ "name": "authorization_id",
+ "description": "authorization_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "removalDate": "2020-11-13",
+ "deprecationDate": "2020-02-14",
+ "category": "oauth-authorizations",
+ "subcategory": null
+ },
+ "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://docs.github.com/enterprise-server@2.19/v3/codes_of_conduct/#get-all-codes-of-conduct"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ }
+ }
+ },
+ "/codes_of_conduct/{key}": {
+ "get": {
+ "summary": "Get a code of conduct",
+ "description": "",
+ "tags": [
+ "codes-of-conduct"
+ ],
+ "operationId": "codes-of-conduct/get-conduct-code",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/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": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "key": "contributor_covenant",
+ "name": "Contributor Covenant",
+ "url": "https://api.github.com/codes_of_conduct/contributor_covenant",
+ "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n",
+ "html_url": "http://contributor-covenant.org/version/1/4/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "scarlet-witch",
+ "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
+ }
+ ],
+ "category": "codes-of-conduct",
+ "subcategory": null
+ }
+ }
+ },
+ "/content_references/{content_reference_id}/attachments": {
+ "post": {
+ "summary": "Create a content attachment",
+ "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
+ "tags": [
+ "apps"
+ ],
+ "operationId": "apps/create-content-attachment",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment"
+ },
+ "parameters": [
+ {
+ "name": "content_reference_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "title": {
+ "description": "The title of the attachment",
+ "example": "Title of the attachment",
+ "type": "string",
+ "maxLength": 1024
+ },
+ "body": {
+ "description": "The body of the attachment",
+ "example": "Body of the attachment",
+ "type": "string",
+ "maxLength": 262144
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ],
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "id": 101,
+ "title": "[A-1234] Error found in core/models.py file'",
+ "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "Gone",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "415": {
+ "description": "Preview Header Missing",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+ {
+ "required": true,
+ "name": "corsair",
+ "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```"
+ }
+ ],
+ "category": "apps",
+ "subcategory": "installations"
+ }
+ }
+ },
+ "/emojis": {
+ "get": {
+ "summary": "Get emojis",
+ "description": "Lists all the emojis available to use on GitHub Enterprise Server.",
+ "operationId": "emojis/get",
+ "tags": [
+ "emojis"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/emojis/#get-emojis"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "description": "response"
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "emojis",
+ "subcategory": null
+ }
+ }
+ },
+ "/enterprise/settings/license": {
+ "get": {
+ "summary": "Get license information",
+ "description": "",
+ "operationId": "enterprise-admin/get-license-information",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-license-information"
+ },
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "seats": {
+ "type": "integer"
+ },
+ "seats_used": {
+ "type": "integer"
+ },
+ "seats_available": {
+ "type": "integer"
+ },
+ "kind": {
+ "type": "string"
+ },
+ "days_until_expiration": {
+ "type": "integer"
+ },
+ "expire_at": {
+ "type": "string"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "seats": 1400,
+ "seats_used": 1316,
+ "seats_available": 84,
+ "kind": "standard",
+ "days_until_expiration": 365,
+ "expire_at": "2016/02/06 12:41:52 -0600"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "license"
+ }
+ }
+ },
+ "/enterprise/stats/{type}": {
+ "get": {
+ "summary": "Get statistics",
+ "description": "There are a variety of types to choose from:\n\n| Type | Description |\n| ------------ | --------------------------------------------------------------------------------------------------- |\n| `issues` | The number of open and closed issues. |\n| `hooks` | The number of active and inactive hooks. |\n| `milestones` | The number of open and closed milestones. |\n| `orgs` | The number of organizations, teams, team members, and disabled organizations. |\n| `comments` | The number of comments on issues, pull requests, commits, and gists. |\n| `pages` | The number of GitHub Pages sites. |\n| `users` | The number of suspended and admin users. |\n| `gists` | The number of private and public gists. |\n| `pulls` | The number of merged, mergeable, and unmergeable pull requests. |\n| `repos` | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis. |\n| `all` | All of the statistics listed above. |\n\nThese statistics are cached and will be updated approximately every 10 minutes.",
+ "operationId": "enterprise-admin/get-type-stats",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/enterprise-admin#get-statistics"
+ },
+ "parameters": [
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "repos": {
+ "type": "object",
+ "properties": {
+ "total_repos": {
+ "type": "integer"
+ },
+ "root_repos": {
+ "type": "integer"
+ },
+ "fork_repos": {
+ "type": "integer"
+ },
+ "org_repos": {
+ "type": "integer"
+ },
+ "total_pushes": {
+ "type": "integer"
+ },
+ "total_wikis": {
+ "type": "integer"
+ }
+ }
+ },
+ "hooks": {
+ "type": "object",
+ "properties": {
+ "total_hooks": {
+ "type": "integer"
+ },
+ "active_hooks": {
+ "type": "integer"
+ },
+ "inactive_hooks": {
+ "type": "integer"
+ }
+ }
+ },
+ "pages": {
+ "type": "object",
+ "properties": {
+ "total_pages": {
+ "type": "integer"
+ }
+ }
+ },
+ "orgs": {
+ "type": "object",
+ "properties": {
+ "total_orgs": {
+ "type": "integer"
+ },
+ "disabled_orgs": {
+ "type": "integer"
+ },
+ "total_teams": {
+ "type": "integer"
+ },
+ "total_team_members": {
+ "type": "integer"
+ }
+ }
+ },
+ "users": {
+ "type": "object",
+ "properties": {
+ "total_users": {
+ "type": "integer"
+ },
+ "admin_users": {
+ "type": "integer"
+ },
+ "suspended_users": {
+ "type": "integer"
+ }
+ }
+ },
+ "pulls": {
+ "type": "object",
+ "properties": {
+ "total_pulls": {
+ "type": "integer"
+ },
+ "merged_pulls": {
+ "type": "integer"
+ },
+ "mergeable_pulls": {
+ "type": "integer"
+ },
+ "unmergeable_pulls": {
+ "type": "integer"
+ }
+ }
+ },
+ "issues": {
+ "type": "object",
+ "properties": {
+ "total_issues": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "closed_issues": {
+ "type": "integer"
+ }
+ }
+ },
+ "milestones": {
+ "type": "object",
+ "properties": {
+ "total_milestones": {
+ "type": "integer"
+ },
+ "open_milestones": {
+ "type": "integer"
+ },
+ "closed_milestones": {
+ "type": "integer"
+ }
+ }
+ },
+ "gists": {
+ "type": "object",
+ "properties": {
+ "total_gists": {
+ "type": "integer"
+ },
+ "private_gists": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ }
+ }
+ },
+ "comments": {
+ "type": "object",
+ "properties": {
+ "total_commit_comments": {
+ "type": "integer"
+ },
+ "total_gist_comments": {
+ "type": "integer"
+ },
+ "total_issue_comments": {
+ "type": "integer"
+ },
+ "total_pull_request_comments": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "repos": {
+ "total_repos": 212,
+ "root_repos": 194,
+ "fork_repos": 18,
+ "org_repos": 51,
+ "total_pushes": 3082,
+ "total_wikis": 15
+ },
+ "hooks": {
+ "total_hooks": 27,
+ "active_hooks": 23,
+ "inactive_hooks": 4
+ },
+ "pages": {
+ "total_pages": 36
+ },
+ "orgs": {
+ "total_orgs": 33,
+ "disabled_orgs": 0,
+ "total_teams": 60,
+ "total_team_members": 314
+ },
+ "users": {
+ "total_users": 254,
+ "admin_users": 45,
+ "suspended_users": 21
+ },
+ "pulls": {
+ "total_pulls": 86,
+ "merged_pulls": 60,
+ "mergeable_pulls": 21,
+ "unmergeable_pulls": 3
+ },
+ "issues": {
+ "total_issues": 179,
+ "open_issues": 83,
+ "closed_issues": 96
+ },
+ "milestones": {
+ "total_milestones": 7,
+ "open_milestones": 6,
+ "closed_milestones": 1
+ },
+ "gists": {
+ "total_gists": 178,
+ "private_gists": 151,
+ "public_gists": 25
+ },
+ "comments": {
+ "total_commit_comments": 6,
+ "total_gist_comments": 28,
+ "total_issue_comments": 366,
+ "total_pull_request_comments": 30
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "enterprise-admin",
+ "subcategory": "admin-stats"
+ }
+ }
+ },
+ "/events": {
+ "get": {
+ "summary": "List public events",
+ "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/list-public-events",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#list-public-events"
+ },
+ "parameters": [
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Event",
+ "description": "Event",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "nullable": true
+ },
+ "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"
+ ]
+ },
+ "repo": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "url"
+ ]
+ },
+ "org": {
+ "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"
+ ]
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "issue": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "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
+ },
+ "nullable": true
+ },
+ "milestone": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": {
+ "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": [
+ {
+ "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"
+ ]
+ }
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "allow_squash_merge": {
+ "type": "boolean"
+ },
+ "allow_merge_commit": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "anonymous_access_enabled": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ },
+ "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\""
+ },
+ "anonymous_access_enabled": {
+ "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"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-04-14T16:00:49Z"
+ },
+ "issue_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "author_association": {
+ "type": "string",
+ "enum": [
+ "collaborator",
+ "contributor",
+ "first_timer",
+ "first_time_contributor",
+ "mannequin",
+ "member",
+ "none",
+ "owner"
+ ]
+ },
+ "performed_via_github_app": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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
+ }
+ ]
+ },
+ "reactions": {
+ "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"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "html_url",
+ "issue_url",
+ "author_association",
+ "user",
+ "url",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "activity",
+ "subcategory": "events"
+ }
+ }
+ },
+ "/feeds": {
+ "get": {
+ "summary": "Get feeds",
+ "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@2.19/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 Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@2.19/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
+ "tags": [
+ "activity"
+ ],
+ "operationId": "activity/get-feeds",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/activity#get-feeds"
+ },
+ "parameters": [
+
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ },
+ "_links": {
+ "type": "array",
+ "required": [
+ "timeline",
+ "user"
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "timeline": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "user": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_public": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_actor": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_organization": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ },
+ "current_user_organizations": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "_links",
+ "timeline_url",
+ "user_url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ ],
+ "_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"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/v3/gists/#list-gists-for-the-authenticated-user"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "post": {
+ "summary": "Create a gist",
+ "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.",
+ "operationId": "gists/create",
+ "tags": [
+ "gists"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/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": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/public": {
+ "get": {
+ "summary": "List public gists",
+ "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-public",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-public-gists"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/starred": {
+ "get": {
+ "summary": "List starred gists",
+ "description": "List the authenticated user's starred gists:",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-starred",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-starred-gists"
+ },
+ "parameters": [
+ {
+ "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"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "owner": {
+ "nullable": true,
+ "allOf": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
+ "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
+ "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
+ "id": "aa5a315d61ae9438b18d",
+ "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
+ "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
+ "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
+ "files": {
+ "hello_world.rb": {
+ "filename": "hello_world.rb",
+ "type": "application/x-ruby",
+ "language": "Ruby",
+ "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
+ "size": 167
+ }
+ },
+ "public": true,
+ "created_at": "2010-04-14T02:15:15Z",
+ "updated_at": "2011-06-20T11:34:15Z",
+ "description": "Hello World Examples",
+ "comments": 0,
+ "user": null,
+ "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
+ "owner": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "truncated": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires Authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}": {
+ "get": {
+ "summary": "Get a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/get",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#get-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "patch": {
+ "summary": "Update a gist",
+ "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/update",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#update-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ },
+ "examples": {
+ "default": {
+ "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/"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Failed",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ },
+ "delete": {
+ "summary": "Delete a gist",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/delete",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#delete-a-gist"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}/comments": {
+ "get": {
+ "summary": "List gist comments",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-comments",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/gists#list-gist-comments"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/reference/gists#create-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "headers": {
+ "Location": {
+ "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/reference/gists#get-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/reference/gists#update-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "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": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/rest/reference/gists#delete-a-gist-comment"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "comment_id",
+ "description": "comment_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Empty response"
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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://docs.github.com/enterprise-server@2.19/v3/gists/#list-gist-commits"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "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": [
+ {
+ "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
+ }
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "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"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "previews": [
+
+ ],
+ "category": "gists",
+ "subcategory": null
+ }
+ }
+ },
+ "/gists/{gist_id}/forks": {
+ "get": {
+ "summary": "List gist forks",
+ "description": "",
+ "tags": [
+ "gists"
+ ],
+ "operationId": "gists/list-forks",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@2.19/v3/gists/#list-gist-forks"
+ },
+ "parameters": [
+ {
+ "name": "gist_id",
+ "description": "gist_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "Results per page (max 100)",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Gist Full",
+ "description": "Gist Full",
+ "allOf": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ },
+ {
+ "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": [
+ {
+ "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": {
+ "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
+ },
+ "truncated": {
+ "type": "boolean"
+ }
+ }
+ }
+ ]
+ },
+ "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\""
+ }
+ }
+ }
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "url": "https://api.github.com/gists/dee9c42e4998ce2ea439",
+ "id": "dee9c42e4998ce2ea439",
+ "created_at": "2011-04-14T16:00:49Z",
+ "updated_at": "2011-04-14T16:00:49Z"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\",